com.edustructures.sifworks.food
Class FoodserviceMenuPlan

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FoodserviceMenuPlan
extends SIFDataObject

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

FoodserviceMenuPlan()
Constructor

FoodserviceMenuPlan(java.lang.String refId, java.lang.String schoolInfoRefId, GradeLevels gradeLevels, java.util.Calendar menuPlanDate, Program program, java.lang.String projectedParticipation)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the <Description> element.
GradeLevels	getGradeLevels() Gets the value of the <GradeLevels> 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	getMenuPlanDate() Gets the value of the <MenuPlanDate> element.
MenuPlanQuantities	getMenuPlanQuantities() Gets the value of the <MenuPlanQuantities> element.
Program	getProgram() Gets the value of the <Program> element.
java.lang.String	getProjectedParticipation() Gets the value of the <ProjectedParticipation> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getSchoolInfoRefId() Gets the value of the <SchoolInfoRefId> element.
void	removeGradeLevels() Removes the GradeLevels child element previously created by calling setGradeLevels
void	removeMenuPlanQuantities() Removes the MenuPlanQuantities child element previously created by calling setMenuPlanQuantities
void	removeProgram() Removes the Program child element previously created by calling setProgram
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setGradeLevels(GradeLevels value) Sets the value of the <GradeLevels> element.
void	setMenuPlanDate(java.util.Calendar value) Sets the value of the <MenuPlanDate> element.
void	setMenuPlanQuantities(MenuPlanQuantities value) Sets the value of the <MenuPlanQuantities> element.
void	setProgram(FinancialProgram type, java.lang.String value) Sets the value of the <Program> child element.
void	setProgram(Program value) Sets the value of the <Program> element.
void	setProjectedParticipation(java.lang.String value) Sets the value of the <ProjectedParticipation> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSchoolInfoRefId(java.lang.String value) Sets the value of the <SchoolInfoRefId> element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, 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

FoodserviceMenuPlan

public FoodserviceMenuPlan()

Constructor

FoodserviceMenuPlan

public FoodserviceMenuPlan(java.lang.String refId,
                           java.lang.String schoolInfoRefId,
                           GradeLevels gradeLevels,
                           java.util.Calendar menuPlanDate,
                           Program program,
                           java.lang.String projectedParticipation)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this menu plan

schoolInfoRefId - GUID that identifies the school for this menu plan

gradeLevels -

menuPlanDate - Date of menu plan

program -

projectedParticipation - Feeding figure projected

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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies this menu plan"

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

2.0

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies this menu plan"

Parameters:

value - A String object

Since:

2.0

getSchoolInfoRefId

public java.lang.String getSchoolInfoRefId()

Gets the value of the <SchoolInfoRefId> element.

The SIF specification defines the meaning of this element as: "GUID that identifies the school for this menu plan"

Returns:

The SchoolInfoRefId element of this object.

Since:

2.0

setSchoolInfoRefId

public void setSchoolInfoRefId(java.lang.String value)

Sets the value of the <SchoolInfoRefId> element.

The SIF specification defines the meaning of this element as: "GUID that identifies the school for this menu plan"

Parameters:

value - A String object

Since:

2.0

setGradeLevels

public void setGradeLevels(GradeLevels value)

Sets the value of the <GradeLevels> element.

Parameters:

value - A GradeLevels object

Since:

2.0

getGradeLevels

public GradeLevels getGradeLevels()

Gets the value of the <GradeLevels> element.

Returns:

A GradeLevels object

Since:

2.0

removeGradeLevels

public void removeGradeLevels()

Removes the GradeLevels child element previously created by calling setGradeLevels

Since:

2.0

getMenuPlanDate

public java.util.Calendar getMenuPlanDate()

Gets the value of the <MenuPlanDate> element.

The SIF specification defines the meaning of this element as: "Date of menu plan"

Returns:

The MenuPlanDate element of this object.

Since:

2.0

setMenuPlanDate

public void setMenuPlanDate(java.util.Calendar value)

Sets the value of the <MenuPlanDate> element.

The SIF specification defines the meaning of this element as: "Date of menu plan"

Parameters:

value - A Calendar object

Since:

2.0

setProgram

public void setProgram(Program value)

Sets the value of the <Program> element.

Parameters:

value - A Program object

Since:

2.0

setProgram

public void setProgram(FinancialProgram type,
                       java.lang.String value)

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

Parameters:

type - The type of the program. Type identifies the list of values.

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

Since:

2.0

getProgram

public Program getProgram()

Gets the value of the <Program> element.

Returns:

A Program object

Since:

2.0

removeProgram

public void removeProgram()

Removes the Program child element previously created by calling setProgram

Since:

2.0

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Description of menu plan"

Returns:

The Description element of this object.

Since:

2.0

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Description of menu plan"

Parameters:

value - A String object

Since:

2.0

getProjectedParticipation

public java.lang.String getProjectedParticipation()

Gets the value of the <ProjectedParticipation> element.

The SIF specification defines the meaning of this element as: "Feeding figure projected"

Returns:

The ProjectedParticipation element of this object.

Since:

2.0

setProjectedParticipation

public void setProjectedParticipation(java.lang.String value)

Sets the value of the <ProjectedParticipation> element.

The SIF specification defines the meaning of this element as: "Feeding figure projected"

Parameters:

value - A String object

Since:

2.0

setMenuPlanQuantities

public void setMenuPlanQuantities(MenuPlanQuantities value)

Sets the value of the <MenuPlanQuantities> element.

Parameters:

value - A MenuPlanQuantities object

Since:

2.0

getMenuPlanQuantities

public MenuPlanQuantities getMenuPlanQuantities()

Gets the value of the <MenuPlanQuantities> element.

Returns:

A MenuPlanQuantities object

Since:

2.0

removeMenuPlanQuantities

public void removeMenuPlanQuantities()

Removes the MenuPlanQuantities child element previously created by calling setMenuPlanQuantities

Since:

2.0