com.edustructures.sifworks.food
Class FoodserviceItem

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FoodserviceItem
extends SIFDataObject

This object communicates information about food service items. SIF_Events are reported.

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

FoodserviceItem()
Constructor

FoodserviceItem(java.lang.String refId, java.lang.String localId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the <Description> element.
ElectronicIdList	getElectronicIdList() Gets the value of the <ElectronicIdList> element.
java.lang.String	getItemCategory() Gets the value of the <ItemCategory> 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.lang.String	getLocalId() Gets the value of the <LocalId> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
void	removeElectronicIdList() Removes the ElectronicIdList child element previously created by calling setElectronicIdList
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setElectronicIdList(ElectronicIdList value) Sets the value of the <ElectronicIdList> element.
void	setItemCategory(FoodCategoryName value) Sets the value of the <ItemCategory> element.
void	setItemCategory(java.lang.String value) Sets the value of the <ItemCategory> element as a String.
void	setLocalId(java.lang.String value) Sets the value of the <LocalId> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.

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

FoodserviceItem

public FoodserviceItem()

Constructor

FoodserviceItem

public FoodserviceItem(java.lang.String refId,
                       java.lang.String localId)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this item

localId - Item number as presented to user.

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 item"

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.5r1

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 item"

Parameters:

value - A String object

Since:

1.5r1

getLocalId

public java.lang.String getLocalId()

Gets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: "Item number as presented to user."

Returns:

The LocalId element of this object.

Since:

1.5r1

setLocalId

public void setLocalId(java.lang.String value)

Sets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: "Item number as presented to user."

Parameters:

value - A String object

Since:

1.5r1

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 Item"

Returns:

The Description element of this object.

Since:

1.5r1

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 Item"

Parameters:

value - A String object

Since:

1.5r1

setElectronicIdList

public void setElectronicIdList(ElectronicIdList value)

Sets the value of the <ElectronicIdList> element.

The SIF specification defines the meaning of this element as: "Electronic identifier(s) associated with this item."

Parameters:

value - A ElectronicIdList object

Since:

1.5r1

getElectronicIdList

public ElectronicIdList getElectronicIdList()

Gets the value of the <ElectronicIdList> element.

The SIF specification defines the meaning of this element as: "Electronic identifier(s) associated with this item."

Returns:

An ElectronicIdList object

Since:

1.5r1

removeElectronicIdList

public void removeElectronicIdList()

Removes the ElectronicIdList child element previously created by calling setElectronicIdList

Since:

1.5r1

getItemCategory

public java.lang.String getItemCategory()

Gets the value of the <ItemCategory> element.

The SIF specification defines the meaning of this element as: " The category is derived from the Child Nutrition Database's food category codes/names (Source: Food Category Name File [CNDB]). Agents may use the actual codes or a district's local definition of the names associated with the codes. The Child Nutrition Database [CNDB] is updated on a yearly basis by the USDA. "

Returns:

The ItemCategory element of this object.

Since:

1.5r1

setItemCategory

public void setItemCategory(FoodCategoryName value)

Sets the value of the <ItemCategory> element.

The SIF specification defines the meaning of this element as: " The category is derived from the Child Nutrition Database's food category codes/names (Source: Food Category Name File [CNDB]). Agents may use the actual codes or a district's local definition of the names associated with the codes. The Child Nutrition Database [CNDB] is updated on a yearly basis by the USDA. "

Parameters:

value - A constant defined by the FoodCategoryName class

Since:

1.5r1

setItemCategory

public void setItemCategory(java.lang.String value)

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

The SIF specification defines the meaning of this element as: " The category is derived from the Child Nutrition Database's food category codes/names (Source: Food Category Name File [CNDB]). Agents may use the actual codes or a district's local definition of the names associated with the codes. The Child Nutrition Database [CNDB] is updated on a yearly basis by the USDA. "

Parameters:

value - The value as a String

Since:

1.5r1