com.edustructures.sifworks.food
Class StudentMeal

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.food.StudentMeal

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StudentMeal
extends SIFDataObject

This object contains information about the meal status of a student.

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

StudentMeal()
Constructor

StudentMeal(java.lang.String studentPersonalRefId)
Constructor that accepts values for all mandatory fields

Method Summary

FSAmounts	getAmounts() Gets the value of the <Amounts> element.
java.lang.String	getBrkCredits() Gets the value of the <BrkCredits> element.
java.lang.String	getCash() Gets the value of the <Cash> element.
HistoricalMealStatus	getHistoricalMealStatus() Gets the value of the <HistoricalMealStatus> 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
java.util.Calendar	getLastBreakfastDate() Gets the value of the <LastBreakfastDate> element.
java.util.Calendar	getLastBrkDate() Gets the value of the <LastBrkDate> element.
java.util.Calendar	getLastLunchDate() Gets the value of the <LastLunchDate> element.
java.util.Calendar	getLastLunDate() Gets the value of the <LastLunDate> element.
java.lang.String	getLunCredits() Gets the value of the <LunCredits> element.
MealStatus	getMealStatus() Gets the value of the <MealStatus> element.
java.lang.Integer	getSchoolYear() Gets the value of the <SchoolYear> element.
java.lang.String	getStudentPersonalRefId() Gets the value of the StudentPersonalRefId attribute.
void	removeAmounts() Removes the Amounts child element previously created by calling setAmounts
void	removeHistoricalMealStatus() Removes the HistoricalMealStatus child element previously created by calling setHistoricalMealStatus
void	removeMealStatus() Removes the MealStatus child element previously created by calling setMealStatus
void	setAmounts(FSAmounts value) Sets the value of the <Amounts> element.
void	setBrkCredits(java.lang.String value) Sets the value of the <BrkCredits> element.
void	setCash(java.lang.String value) Sets the value of the <Cash> element.
void	setHistoricalMealStatus(HistoricalMealStatus value) Sets the value of the <HistoricalMealStatus> element.
void	setLastBreakfastDate(java.util.Calendar value) Sets the value of the <LastBreakfastDate> element.
void	setLastBrkDate(java.util.Calendar value) Sets the value of the <LastBrkDate> element.
void	setLastLunchDate(java.util.Calendar value) Sets the value of the <LastLunchDate> element.
void	setLastLunDate(java.util.Calendar value) Sets the value of the <LastLunDate> element.
void	setLunCredits(java.lang.String value) Sets the value of the <LunCredits> 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	setSchoolYear(java.lang.Integer value) Sets the value of the <SchoolYear> element.
void	setStudentPersonalRefId(java.lang.String value) Sets the value of the StudentPersonalRefId attribute.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getRefId, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

StudentMeal

public StudentMeal()

Constructor

StudentMeal

public StudentMeal(java.lang.String studentPersonalRefId)

Constructor that accepts values for all mandatory fields

Parameters:

studentPersonalRefId - The GUID of the student to whom this object is linked.

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

getStudentPersonalRefId

public java.lang.String getStudentPersonalRefId()

Gets the value of the StudentPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of the student to whom this object is linked."

Returns:

The StudentPersonalRefId attribute of this object.

Since:

1.1

setStudentPersonalRefId

public void setStudentPersonalRefId(java.lang.String value)

Sets the value of the StudentPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of the student to whom this object is linked."

Parameters:

value - A String object

Since:

1.1

setMealStatus

public void setMealStatus(MealStatus value)

Sets the value of the <MealStatus> element.

The SIF specification defines the meaning of this element as: "Information about a student's meal status"

Parameters:

value - A MealStatus object

Since:

1.1

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.1

getMealStatus

public MealStatus getMealStatus()

Gets the value of the <MealStatus> element.

The SIF specification defines the meaning of this element as: "Information about a student's meal status"

Returns:

A MealStatus object

Since:

1.1

removeMealStatus

public void removeMealStatus()

Removes the MealStatus child element previously created by calling setMealStatus

Since:

1.1

getSchoolYear

public java.lang.Integer getSchoolYear()

Gets the value of the <SchoolYear> element.

The SIF specification defines the meaning of this element as: "School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2004" for the 2003-04 school year)."

Returns:

The SchoolYear element of this object.

Since:

1.5r1

setSchoolYear

public void setSchoolYear(java.lang.Integer value)

Sets the value of the <SchoolYear> element.

The SIF specification defines the meaning of this element as: "School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2004" for the 2003-04 school year)."

Parameters:

value - A Integer object

Since:

1.5r1

setHistoricalMealStatus

public void setHistoricalMealStatus(HistoricalMealStatus value)

Sets the value of the <HistoricalMealStatus> element.

The SIF specification defines the meaning of this element as: "Optionally provides the meal status of the student historically."

Parameters:

value - A HistoricalMealStatus object

Since:

2.0

getHistoricalMealStatus

public HistoricalMealStatus getHistoricalMealStatus()

Gets the value of the <HistoricalMealStatus> element.

The SIF specification defines the meaning of this element as: "Optionally provides the meal status of the student historically."

Returns:

An HistoricalMealStatus object

Since:

2.0

removeHistoricalMealStatus

public void removeHistoricalMealStatus()

Removes the HistoricalMealStatus child element previously created by calling setHistoricalMealStatus

Since:

2.0

getLastBreakfastDate

public java.util.Calendar getLastBreakfastDate()

Gets the value of the <LastBreakfastDate> element.

The SIF specification defines the meaning of this element as: "Date of the last reimbursable breakfast served."

This element 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 elements of this kind.

Version	Tag
1.1	"LastBrkDate"
SIF2.0	"LastBreakfastDate"
SIF1.5r1	"LastBreakfastDate"

Returns:

The LastBreakfastDate element of this object.

Since:

1.1

setLastBreakfastDate

public void setLastBreakfastDate(java.util.Calendar value)

Sets the value of the <LastBreakfastDate> element.

The SIF specification defines the meaning of this element as: "Date of the last reimbursable breakfast served."

This element 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 elements of this kind.

Version	Tag
1.1	"LastBrkDate"
SIF2.0	"LastBreakfastDate"
SIF1.5r1	"LastBreakfastDate"

Parameters:

value - A Calendar object

Since:

1.1

getLastLunchDate

public java.util.Calendar getLastLunchDate()

Gets the value of the <LastLunchDate> element.

The SIF specification defines the meaning of this element as: "Date of the last reimbursable lunch served."

This element 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 elements of this kind.

Version	Tag
1.1	"LastLunDate"
SIF2.0	"LastLunchDate"
SIF1.5r1	"LastLunchDate"

Returns:

The LastLunchDate element of this object.

Since:

1.1

setLastLunchDate

public void setLastLunchDate(java.util.Calendar value)

Sets the value of the <LastLunchDate> element.

The SIF specification defines the meaning of this element as: "Date of the last reimbursable lunch served."

This element 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 elements of this kind.

Version	Tag
1.1	"LastLunDate"
SIF2.0	"LastLunchDate"
SIF1.5r1	"LastLunchDate"

Parameters:

value - A Calendar object

Since:

1.1

getLastBrkDate

public java.util.Calendar getLastBrkDate()

Gets the value of the <LastBrkDate> element.

The SIF specification defines the meaning of this element as: "Date the student last had breakfast (deprecated)"

Returns:

The LastBrkDate element of this object.

Since:

1.5r1

setLastBrkDate

public void setLastBrkDate(java.util.Calendar value)

Sets the value of the <LastBrkDate> element.

The SIF specification defines the meaning of this element as: "Date the student last had breakfast (deprecated)"

Parameters:

value - A Calendar object

Since:

1.5r1

getCash

public java.lang.String getCash()

Gets the value of the <Cash> element.

The SIF specification defines the meaning of this element as: "The student's cash balance (deprecated)"

Returns:

The Cash element of this object.

Since:

1.1

setCash

public void setCash(java.lang.String value)

Sets the value of the <Cash> element.

The SIF specification defines the meaning of this element as: "The student's cash balance (deprecated)"

Parameters:

value - A String object

Since:

1.1

getLastLunDate

public java.util.Calendar getLastLunDate()

Gets the value of the <LastLunDate> element.

The SIF specification defines the meaning of this element as: "Date the student last had lunch (deprecated)"

Returns:

The LastLunDate element of this object.

Since:

1.5r1

setLastLunDate

public void setLastLunDate(java.util.Calendar value)

Sets the value of the <LastLunDate> element.

The SIF specification defines the meaning of this element as: "Date the student last had lunch (deprecated)"

Parameters:

value - A Calendar object

Since:

1.5r1

getBrkCredits

public java.lang.String getBrkCredits()

Gets the value of the <BrkCredits> element.

The SIF specification defines the meaning of this element as: "Number of breakfast credits remaining (deprecated)"

Returns:

The BrkCredits element of this object.

Since:

1.1

setBrkCredits

public void setBrkCredits(java.lang.String value)

Sets the value of the <BrkCredits> element.

The SIF specification defines the meaning of this element as: "Number of breakfast credits remaining (deprecated)"

Parameters:

value - A String object

Since:

1.1

getLunCredits

public java.lang.String getLunCredits()

Gets the value of the <LunCredits> element.

The SIF specification defines the meaning of this element as: "Number of lunch credits remaining (deprecated)"

Returns:

The LunCredits element of this object.

Since:

1.1

setLunCredits

public void setLunCredits(java.lang.String value)

Sets the value of the <LunCredits> element.

The SIF specification defines the meaning of this element as: "Number of lunch credits remaining (deprecated)"

Parameters:

value - A String object

Since:

1.1

setAmounts

public void setAmounts(FSAmounts value)

Sets the value of the <Amounts> element.

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

Parameters:

value - A FSAmounts object

Since:

1.5r1

getAmounts

public FSAmounts getAmounts()

Gets the value of the <Amounts> element.

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

Returns:

A FSAmounts object

Since:

1.5r1

removeAmounts

public void removeAmounts()

Removes the Amounts child element previously created by calling setAmounts

Since:

1.5r1