com.edustructures.sifworks.hrfin
Class AnnualItems

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<AnnualItem>
              com.edustructures.sifworks.hrfin.AnnualItems

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<AnnualItem>, java.util.Collection<AnnualItem>

public class AnnualItems
extends SIFList<AnnualItem>

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

AnnualItems()
Constructor

AnnualItems(AnnualItem annualItem)
Constructor that accepts values for all mandatory fields

Method Summary

void	addAnnualItem(AccountClass accountType, FundType fundType, java.lang.String function, java.math.BigDecimal amount) Adds a new <AnnualItem> repeatable element.
AnnualItem	getAnnualItem(AccountClass accountType, FundType fundType, java.lang.String function, java.math.BigDecimal amount) Gets an AnnualItem object instance.
AnnualItem[]	getAnnualItems() Gets all AnnualItem object instances.
void	removeAnnualItem(AccountClass accountType, FundType fundType, java.lang.String function, java.math.BigDecimal amount) Removes an AnnualItem object instance.
void	setAnnualItems(AnnualItem[] annualitems) Sets an array of AnnualItem objects.

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

AnnualItems

public AnnualItems()

Constructor

AnnualItems

public AnnualItems(AnnualItem annualItem)

Constructor that accepts values for all mandatory fields

Parameters:

annualItem -

Method Detail

addAnnualItem

public void addAnnualItem(AccountClass accountType,
                          FundType fundType,
                          java.lang.String function,
                          java.math.BigDecimal amount)

Adds a new <AnnualItem> repeatable element. This form of setAnnualItem is provided as a convenience method that is functionally equivalent to the version of setAnnualItem that accepts a single AnnualItem object.

Parameters:

accountType - Classification of budgetary account code summary

fundType - Is the account a general or special account code designation?

function - Function break in account code for summarization.

amount - Summarized amount.

Since:

1.5r1

removeAnnualItem

public void removeAnnualItem(AccountClass accountType,
                             FundType fundType,
                             java.lang.String function,
                             java.math.BigDecimal amount)

Removes an AnnualItem object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

accountType - Identifies the AnnualItem object to remove by its AccountType value

fundType - Identifies the AnnualItem object to remove by its FundType value

function - Identifies the AnnualItem object to remove by its Function value

amount - Identifies the AnnualItem object to remove by its Amount value

Since:

1.5r1

getAnnualItem

public AnnualItem getAnnualItem(AccountClass accountType,
                                FundType fundType,
                                java.lang.String function,
                                java.math.BigDecimal amount)

Gets an AnnualItem object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

accountType - Identifies the AnnualItem object to return by its "AccountType" attribute value

fundType - Identifies the AnnualItem object to return by its "FundType" attribute value

function - Identifies the AnnualItem object to return by its "Function" attribute value

amount - Identifies the AnnualItem object to return by its "Amount" attribute value

Returns:

An AnnualItem object

Since:

1.5r1

getAnnualItems

public AnnualItem[] getAnnualItems()

Gets all AnnualItem object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of AnnualItem objects

Since:

1.5r1

setAnnualItems

public void setAnnualItems(AnnualItem[] annualitems)

Sets an array of AnnualItem objects. All existing AnnualItem instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all AnnualItems.

Since:

1.5r1