com.edustructures.sifworks.food
Class FoodserviceItemUnit

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FoodserviceItemUnit
extends SIFDataObject

This object describes the unit for an item. 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

FoodserviceItemUnit()
Constructor

FoodserviceItemUnit(java.lang.String refId, java.lang.String foodserviceItemRefId, java.lang.String description, java.lang.String measureDescriptionCode, java.math.BigDecimal gramWeight)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the <Description> element.
java.lang.String	getFoodserviceItemRefId() Gets the value of the <FoodserviceItemRefId> element.
java.math.BigDecimal	getGramWeight() Gets the value of the <GramWeight> 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	getMeasureDescriptionCode() Gets the value of the <MeasureDescriptionCode> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setFoodserviceItemRefId(java.lang.String value) Sets the value of the <FoodserviceItemRefId> element.
void	setGramWeight(java.math.BigDecimal value) Sets the value of the <GramWeight> element.
void	setMeasureDescriptionCode(java.lang.String value) Sets the value of the <MeasureDescriptionCode> 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

FoodserviceItemUnit

public FoodserviceItemUnit()

Constructor

FoodserviceItemUnit

public FoodserviceItemUnit(java.lang.String refId,
                           java.lang.String foodserviceItemRefId,
                           java.lang.String description,
                           java.lang.String measureDescriptionCode,
                           java.math.BigDecimal gramWeight)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this unit

foodserviceItemRefId - GUID that identifies related item

description - Description of unit ("cup", "teaspoon", etc.)

measureDescriptionCode - Child Nutrition Database [CNDB] standard code describing unit. The database is updated on a yearly basis by the USDA.

gramWeight - Gram weight of this item in terms of MeasureDescriptionCode

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

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

Parameters:

value - A String object

Since:

1.5r1

getFoodserviceItemRefId

public java.lang.String getFoodserviceItemRefId()

Gets the value of the <FoodserviceItemRefId> element.

The SIF specification defines the meaning of this element as: "GUID that identifies related item"

Returns:

The FoodserviceItemRefId element of this object.

Since:

1.5r1

setFoodserviceItemRefId

public void setFoodserviceItemRefId(java.lang.String value)

Sets the value of the <FoodserviceItemRefId> element.

The SIF specification defines the meaning of this element as: "GUID that identifies related item"

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 unit ("cup", "teaspoon", etc.)"

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 unit ("cup", "teaspoon", etc.)"

Parameters:

value - A String object

Since:

1.5r1

getMeasureDescriptionCode

public java.lang.String getMeasureDescriptionCode()

Gets the value of the <MeasureDescriptionCode> element.

The SIF specification defines the meaning of this element as: "Child Nutrition Database [CNDB] standard code describing unit. The database is updated on a yearly basis by the USDA."

Returns:

The MeasureDescriptionCode element of this object.

Since:

1.5r1

setMeasureDescriptionCode

public void setMeasureDescriptionCode(java.lang.String value)

Sets the value of the <MeasureDescriptionCode> element.

The SIF specification defines the meaning of this element as: "Child Nutrition Database [CNDB] standard code describing unit. The database is updated on a yearly basis by the USDA."

Parameters:

value - A String object

Since:

1.5r1

getGramWeight

public java.math.BigDecimal getGramWeight()

Gets the value of the <GramWeight> element.

The SIF specification defines the meaning of this element as: "Gram weight of this item in terms of MeasureDescriptionCode"

Returns:

The GramWeight element of this object.

Since:

1.5r1

setGramWeight

public void setGramWeight(java.math.BigDecimal value)

Sets the value of the <GramWeight> element.

The SIF specification defines the meaning of this element as: "Gram weight of this item in terms of MeasureDescriptionCode"

Parameters:

value - A BigDecimal object

Since:

1.5r1