com.edustructures.sifworks.food
Class SalesAmounts

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<SalesAmount>
                  com.edustructures.sifworks.food.SalesAmounts

All Implemented Interfaces:

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

public class SalesAmounts
extends SIFKeyedList<SalesAmount>

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

SalesAmounts()
Constructor

SalesAmounts(SalesAmount salesAmount)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSalesAmount(SalesAmountType type, AccountType accountType, java.lang.String value) Adds a new <SalesAmount> repeatable element.
SalesAmount	getSalesAmount(java.lang.String value) Gets a SalesAmount object instance.
SalesAmount[]	getSalesAmounts() Gets all SalesAmount object instances.
void	removeSalesAmount(java.lang.String value) Removes a SalesAmount object instance.
void	setSalesAmounts(SalesAmount[] salesamounts) Sets an array of SalesAmount objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

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, 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

SalesAmounts

public SalesAmounts()

Constructor

SalesAmounts

public SalesAmounts(SalesAmount salesAmount)

Constructor that accepts values for all mandatory fields

Parameters:

salesAmount - Dollar value

Method Detail

addSalesAmount

public void addSalesAmount(SalesAmountType type,
                           AccountType accountType,
                           java.lang.String value)

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

Parameters:

type - Type of SalesAmount. This denotes the form of incoming funds for the sales done.

accountType - Type of account to which sales amounts apply. This is set to NA when Type is set as Earned.

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

Since:

1.5r1

removeSalesAmount

public void removeSalesAmount(java.lang.String value)

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

Parameters:

value - Identifies the SalesAmount object to remove by its Value value

Since:

1.5r1

getSalesAmount

public SalesAmount getSalesAmount(java.lang.String value)

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

Parameters:

value - Identifies the SalesAmount object to return by its "Value" attribute value

Returns:

A SalesAmount object

Since:

1.5r1

getSalesAmounts

public SalesAmount[] getSalesAmounts()

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

Returns:

An array of SalesAmount objects

Since:

1.5r1

setSalesAmounts

public void setSalesAmounts(SalesAmount[] salesamounts)

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

Since:

1.5r1