com.edustructures.sifworks.food
Class Rate

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Rate
extends SIFKeyedElement

Reimbursement Rate of the meal

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

Rate()
Constructor

Rate(YesNoNA severeNeed, java.lang.String value, MealStatus mealStatus)
Constructor that accepts values for all mandatory fields

Method Summary

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	getSevereNeed() Gets the value of the SevereNeed attribute.
java.lang.String	getValue() Gets the value of the Value attribute.
void	removeMealStatus() Removes the MealStatus child element previously created by calling setMealStatus
void	setMealStatus(FreeReducedStatus type) Sets the value of the <MealStatus> child element.
void	setMealStatus(MealStatus value) Sets the value of the <MealStatus> element.
void	setSevereNeed(java.lang.String value) Sets the value of the SevereNeed attribute as a String.
void	setSevereNeed(YesNoNA value) Sets the value of the SevereNeed attribute.
void	setValue(java.lang.String value) Sets the value of the Value attribute.

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

Rate

public Rate()

Constructor

Rate

public Rate(YesNoNA severeNeed,
            java.lang.String value,
            MealStatus mealStatus)

Constructor that accepts values for all mandatory fields

Parameters:

severeNeed - Severe need identifier for the rate. When SevereNeed is Yes then the rate shown is the combined rate. For certain programs the severe need identifier does not apply. In such cases the value NA should be used.

value - The rate value

mealStatus - This gives information about a student's meal status.

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

getSevereNeed

public java.lang.String getSevereNeed()

Gets the value of the SevereNeed attribute.

The SIF specification defines the meaning of this attribute as: " Severe need identifier for the rate. When SevereNeed is Yes then the rate shown is the combined rate. For certain programs the severe need identifier does not apply. In such cases the value NA should be used. "

Returns:

The SevereNeed attribute of this object.

Since:

1.5r1

setSevereNeed

public void setSevereNeed(YesNoNA value)

Sets the value of the SevereNeed attribute.

The SIF specification defines the meaning of this attribute as: " Severe need identifier for the rate. When SevereNeed is Yes then the rate shown is the combined rate. For certain programs the severe need identifier does not apply. In such cases the value NA should be used. "

Parameters:

value - A constant defined by the YesNoNA class

Since:

1.5r1

setSevereNeed

public void setSevereNeed(java.lang.String value)

Sets the value of the SevereNeed attribute as a String.

The SIF specification defines the meaning of this attribute as: " Severe need identifier for the rate. When SevereNeed is Yes then the rate shown is the combined rate. For certain programs the severe need identifier does not apply. In such cases the value NA should be used. "

Parameters:

value - The value as a String

Since:

1.5r1

getValue

public java.lang.String getValue()

Gets the value of the Value attribute.

The SIF specification defines the meaning of this attribute as: "The rate value"

Returns:

The Value attribute of this object.

Since:

1.5r1

setValue

public void setValue(java.lang.String value)

Sets the value of the Value attribute.

The SIF specification defines the meaning of this attribute as: "The rate value"

Parameters:

value - A String object

Since:

1.5r1

setMealStatus

public void setMealStatus(MealStatus value)

Sets the value of the <MealStatus> element.

The SIF specification defines the meaning of this element as: "This gives information about a student's meal status."

Parameters:

value - A MealStatus object

Since:

1.5r1

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:

1.5r1

getMealStatus

public MealStatus getMealStatus()

Gets the value of the <MealStatus> element.

The SIF specification defines the meaning of this element as: "This gives information about a student's meal status."

Returns:

A MealStatus object

Since:

1.5r1

removeMealStatus

public void removeMealStatus()

Removes the MealStatus child element previously created by calling setMealStatus

Since:

1.5r1