com.edustructures.sifworks.hrfin
Class FISAmounts

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<FISAmount>
              com.edustructures.sifworks.hrfin.FISAmounts

All Implemented Interfaces:

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

public class FISAmounts
extends SIFList<FISAmount>

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

FISAmounts()
Constructor

FISAmounts(FISAmount amount)
Constructor that accepts values for all mandatory fields

Method Summary

void	addAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId, java.lang.String financialClassRefId, java.lang.String value) Adds a new <Amount> repeatable element.
FISAmount	getAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId, java.lang.String financialClassRefId) Gets a FISAmount object instance.
FISAmount[]	getAmounts() Gets all FISAmount object instances.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
void	removeAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId, java.lang.String financialClassRefId) Removes a FISAmount object instance.
void	setAmounts(FISAmount[] amounts) Sets an array of FISAmount 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, 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

FISAmounts

public FISAmounts()

Constructor

FISAmounts

public FISAmounts(FISAmount amount)

Constructor that accepts values for all mandatory fields

Parameters:

amount -

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

addAmount

public void addAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId,
                      java.lang.String financialClassRefId,
                      java.lang.String value)

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

Parameters:

financialAccountAccountingPeriodLocationInfoRefId - FinancialAccountAccountingPeriodLocationInfo reference.

financialClassRefId - Class of the financial account.

value - Gets or sets the content value of the <FISAmount> element

Since:

1.5r1

removeAmount

public void removeAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId,
                         java.lang.String financialClassRefId)

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

Parameters:

financialAccountAccountingPeriodLocationInfoRefId - Identifies the FISAmount object to remove by its FinancialAccountAccountingPeriodLocationInfoRefId value

financialClassRefId - Identifies the FISAmount object to remove by its FinancialClassRefId value

Since:

1.5r1

getAmount

public FISAmount getAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId,
                           java.lang.String financialClassRefId)

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

Parameters:

financialAccountAccountingPeriodLocationInfoRefId - Identifies the FISAmount object to return by its "FinancialAccountAccountingPeriodLocationInfoRefId" attribute value

financialClassRefId - Identifies the FISAmount object to return by its "FinancialClassRefId" attribute value

Returns:

A FISAmount object

Since:

1.5r1

getAmounts

public FISAmount[] getAmounts()

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

Returns:

An array of FISAmount objects

Since:

1.5r1

setAmounts

public void setAmounts(FISAmount[] amounts)

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

Since:

1.5r1