com.edustructures.sifworks.food
Class FSAmount

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.food.FSAmount

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FSAmount
extends SIFKeyedElement

Amount

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

FSAmount()
Constructor

FSAmount(FSAmountType type, java.math.BigDecimal credits, java.lang.String value)
Constructor that accepts values for all mandatory fields

Method Summary

java.math.BigDecimal	getCredits() Gets the value of the Credits attribute.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.String	getType() Gets the value of the Type attribute.
java.lang.String	getValue() Gets the value of the <Value> element.
void	setCredits(java.math.BigDecimal value) Sets the value of the Credits attribute.
void	setType(FSAmountType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.
void	setValue(java.lang.String value) Sets the value of the <Value> element.

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

Constructor Detail

FSAmount

public FSAmount()

Constructor

FSAmount

public FSAmount(FSAmountType type,
                java.math.BigDecimal credits,
                java.lang.String value)

Constructor that accepts values for all mandatory fields

Parameters:

type - Type of amount. The currency unit is implied; namely USD. Note that when this common element is used not all of the following values apply. There are notes to indicate values that are applicable.

credits - Number of credits. This attribute does not apply to Cash or Value and hence has a value 0. It only applies to types BreakfastCredit and LunchCredit.

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

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

getValue

public java.lang.String getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <FSAmount> element"

Returns:

The Value element of this object.

Since:

1.5r1

setValue

public void setValue(java.lang.String value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <FSAmount> element"

Parameters:

value - A String object

Since:

1.5r1

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: " Type of amount. The currency unit is implied; namely USD. Note that when this common element is used not all of the following values apply. There are notes to indicate values that are applicable. "

Returns:

The Type attribute of this object.

Since:

1.5r1

setType

public void setType(FSAmountType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: " Type of amount. The currency unit is implied; namely USD. Note that when this common element is used not all of the following values apply. There are notes to indicate values that are applicable. "

Parameters:

value - A constant defined by the FSAmountType class

Since:

1.5r1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

The SIF specification defines the meaning of this attribute as: " Type of amount. The currency unit is implied; namely USD. Note that when this common element is used not all of the following values apply. There are notes to indicate values that are applicable. "

Parameters:

value - The value as a String

Since:

1.5r1

getCredits

public java.math.BigDecimal getCredits()

Gets the value of the Credits attribute.

The SIF specification defines the meaning of this attribute as: " Number of credits. This attribute does not apply to Cash or Value and hence has a value 0. It only applies to types BreakfastCredit and LunchCredit. "

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"Quantity"
SIF2.0	"Credits"

Returns:

The Credits attribute of this object.

Since:

1.5r1

setCredits

public void setCredits(java.math.BigDecimal value)

Sets the value of the Credits attribute.

The SIF specification defines the meaning of this attribute as: " Number of credits. This attribute does not apply to Cash or Value and hence has a value 0. It only applies to types BreakfastCredit and LunchCredit. "

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"Quantity"
SIF2.0	"Credits"

Parameters:

value - A BigDecimal object

Since:

1.5r1