com.edustructures.sifworks.food
Class Count

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Count
extends SIFKeyedElement

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Count()
Constructor

Count(java.math.BigDecimal value)
Constructor that accepts values for all mandatory fields

Method Summary

FSAmount	getAmount() Gets the value of the <Amount> element.
EarnedStatus	getEarnedStatus() Gets the value of the <EarnedStatus> element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
MealStatus	getMealStatus() Gets the value of the <MealStatus> element.
java.lang.String	getMealType() Gets the value of the <MealType> element.
java.math.BigDecimal	getTax() Gets the value of the <Tax> element.
java.math.BigDecimal	getValue() Gets the value of the <Value> element.
void	removeAmount() Removes the Amount child element previously created by calling setAmount
void	removeEarnedStatus() Removes the EarnedStatus child element previously created by calling setEarnedStatus
void	removeMealStatus() Removes the MealStatus child element previously created by calling setMealStatus
void	setAmount(FSAmount value) Sets the value of the <Amount> element.
void	setAmount(FSAmountType type, java.math.BigDecimal credits, java.lang.String value) Sets the value of the <Amount> child element.
void	setEarnedStatus(EarnedStatus value) Sets the value of the <EarnedStatus> element.
void	setEarnedStatus(YesNoNA type) Sets the value of the <EarnedStatus> child element.
void	setMealStatus(FreeReducedStatus type) Sets the value of the <MealStatus> child element.
void	setMealStatus(MealStatus value) Sets the value of the <MealStatus> element.
void	setMealType(MealTypes value) Sets the value of the <MealType> element.
void	setMealType(java.lang.String value) Sets the value of the <MealType> element as a String.
void	setTax(java.math.BigDecimal value) Sets the value of the <Tax> element.
void	setValue(java.math.BigDecimal 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

Count

public Count()

Constructor

Count

public Count(java.math.BigDecimal value)

Constructor that accepts values for all mandatory fields

Parameters:

value - The value of the count.

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

setMealStatus

public void setMealStatus(MealStatus value)

Sets the value of the <MealStatus> element.

The SIF specification defines the meaning of this element as: "Student meal status. If a meal status applies, either MealStatus (for students), or EarnedStatus (for staff) is specified."

Parameters:

value - A MealStatus object

Since:

2.0

setMealStatus

public void setMealStatus(FreeReducedStatus type)

Sets the value of the <MealStatus> child element. This form of setMealStatus is provided as a convenience method that is functionally equivalent to the version of setMealStatus that accepts a single MealStatus object.

Parameters:

type - Meal status type.

Since:

2.0

getMealStatus

public MealStatus getMealStatus()

Gets the value of the <MealStatus> element.

The SIF specification defines the meaning of this element as: "Student meal status. If a meal status applies, either MealStatus (for students), or EarnedStatus (for staff) is specified."

Returns:

A MealStatus object

Since:

2.0

removeMealStatus

public void removeMealStatus()

Removes the MealStatus child element previously created by calling setMealStatus

Since:

2.0

setEarnedStatus

public void setEarnedStatus(EarnedStatus value)

Sets the value of the <EarnedStatus> element.

The SIF specification defines the meaning of this element as: "Staff meal status."

Parameters:

value - A EarnedStatus object

Since:

2.0

setEarnedStatus

public void setEarnedStatus(YesNoNA type)

Sets the value of the <EarnedStatus> child element. This form of setEarnedStatus is provided as a convenience method that is functionally equivalent to the version of setEarnedStatus that accepts a single EarnedStatus object.

Parameters:

type - Earned status type.

Since:

2.0

getEarnedStatus

public EarnedStatus getEarnedStatus()

Gets the value of the <EarnedStatus> element.

The SIF specification defines the meaning of this element as: "Staff meal status."

Returns:

An EarnedStatus object

Since:

2.0

removeEarnedStatus

public void removeEarnedStatus()

Removes the EarnedStatus child element previously created by calling setEarnedStatus

Since:

2.0

getMealType

public java.lang.String getMealType()

Gets the value of the <MealType> element.

Returns:

The MealType element of this object.

Since:

2.0

setMealType

public void setMealType(MealTypes value)

Sets the value of the <MealType> element.

Parameters:

value - A constant defined by the MealTypes class

Since:

2.0

setMealType

public void setMealType(java.lang.String value)

Sets the value of the <MealType> element as a String.

Parameters:

value - The value as a String

Since:

2.0

setAmount

public void setAmount(FSAmount value)

Sets the value of the <Amount> element.

Parameters:

value - A FSAmount object

Since:

2.0

setAmount

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

Sets the value of the <Amount> child element. This form of setAmount is provided as a convenience method that is functionally equivalent to the version of setAmount that accepts a single FSAmount object.

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

Since:

2.0

getAmount

public FSAmount getAmount()

Gets the value of the <Amount> element.

Returns:

A FSAmount object

Since:

2.0

removeAmount

public void removeAmount()

Removes the Amount child element previously created by calling setAmount

Since:

2.0

getTax

public java.math.BigDecimal getTax()

Gets the value of the <Tax> element.

The SIF specification defines the meaning of this element as: "Dollar value of tax collected."

Returns:

The Tax element of this object.

Since:

2.0

setTax

public void setTax(java.math.BigDecimal value)

Sets the value of the <Tax> element.

The SIF specification defines the meaning of this element as: "Dollar value of tax collected."

Parameters:

value - A BigDecimal object

Since:

2.0

getValue

public java.math.BigDecimal getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "The value of the count."

Returns:

The Value element of this object.

Since:

2.0

setValue

public void setValue(java.math.BigDecimal value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "The value of the count."

Parameters:

value - A BigDecimal object

Since:

2.0