com.edustructures.sifworks.hrfin
Class FTAmounts

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<FTAmount>
              com.edustructures.sifworks.hrfin.FTAmounts

All Implemented Interfaces:

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

public class FTAmounts
extends SIFList<FTAmount>

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

FTAmounts()
Constructor

FTAmounts(FTAmount amount)
Constructor that accepts values for all mandatory fields

Method Summary

void	addAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId, FTAmountType type, java.lang.String value) Adds a new <Amount> repeatable element.
FTAmount	getAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId, FTAmountType type) Gets a FTAmount object instance.
FTAmount[]	getAmounts() Gets all FTAmount object instances.
void	removeAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId, FTAmountType type) Removes a FTAmount object instance.
void	setAmounts(FTAmount[] amounts) Sets an array of FTAmount 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

FTAmounts

public FTAmounts()

Constructor

FTAmounts

public FTAmounts(FTAmount amount)

Constructor that accepts values for all mandatory fields

Parameters:

amount -

Method Detail

addAmount

public void addAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId,
                      FTAmountType type,
                      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 FTAmount object.

Parameters:

financialAccountAccountingPeriodLocationInfoRefId - Account.

type - Values: Debit, Credit

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

Since:

1.5r1

removeAmount

public void removeAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId,
                         FTAmountType type)

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

Parameters:

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

type - Identifies the FTAmount object to remove by its Type value

Since:

1.5r1

getAmount

public FTAmount getAmount(java.lang.String financialAccountAccountingPeriodLocationInfoRefId,
                          FTAmountType type)

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

Parameters:

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

type - Identifies the FTAmount object to return by its "Type" attribute value

Returns:

A FTAmount object

Since:

1.5r1

getAmounts

public FTAmount[] getAmounts()

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

Returns:

An array of FTAmount objects

Since:

1.5r1

setAmounts

public void setAmounts(FTAmount[] amounts)

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

Since:

1.5r1