com.edustructures.sifworks.food
Class HistoricalMealStatus

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<MealStatus>
                  com.edustructures.sifworks.food.HistoricalMealStatus

All Implemented Interfaces:

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

public class HistoricalMealStatus
extends SIFKeyedList<MealStatus>

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

HistoricalMealStatus()
Constructor

HistoricalMealStatus(MealStatus mealStatus)
Constructor that accepts values for all mandatory fields

Method Summary

void	addMealStatus(FreeReducedStatus type) Adds a new <MealStatus> repeatable element.
MealStatus	getMealStatus(FreeReducedStatus type) Gets a MealStatus object instance.
MealStatus[]	getMealStatuses() Gets all MealStatus object instances.
void	removeMealStatus(FreeReducedStatus type) Removes a MealStatus object instance.
void	setMealStatuses(MealStatus[] mealstatuses) Sets an array of MealStatus 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

HistoricalMealStatus

public HistoricalMealStatus()

Constructor

HistoricalMealStatus

public HistoricalMealStatus(MealStatus mealStatus)

Constructor that accepts values for all mandatory fields

Parameters:

mealStatus - The student's meal status. Note that as this status is historical, StartDate and EndDate together, and/or SchoolYear MUST be included. If SchoolYear is included, StartDate and EndDate should not cross school year boundaries, i.e. in addition to multiple statuses being a possibility in a given school year, the same status may be repeated so StartDate and EndDate don't disagree with SchoolYear, if included.

Method Detail

addMealStatus

public void addMealStatus(FreeReducedStatus type)

Adds a new <MealStatus> repeatable 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

removeMealStatus

public void removeMealStatus(FreeReducedStatus type)

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

Parameters:

type - Identifies the MealStatus object to remove by its Type value

Since:

2.0

getMealStatus

public MealStatus getMealStatus(FreeReducedStatus type)

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

Parameters:

type - Identifies the MealStatus object to return by its "Type" attribute value

Returns:

A MealStatus object

Since:

2.0

getMealStatuses

public MealStatus[] getMealStatuses()

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

Returns:

An array of MealStatus objects

Since:

2.0

setMealStatuses

public void setMealStatuses(MealStatus[] mealstatuses)

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

Since:

2.0