com.edustructures.sifworks.food
Class FoodserviceItemPortion

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FoodserviceItemPortion
extends SIFDataObject

Note that this version of the object does not contain any object that define item pricing. This task is left for future implementations.

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

FoodserviceItemPortion()
Constructor

FoodserviceItemPortion(java.lang.String refId, java.lang.String foodserviceItemUnitRefId, java.math.BigDecimal itemPortionQuantity, ItemPortionTypeValue itemPortionType)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the <Description> element.
java.lang.String	getFoodserviceItemUnitRefId() Gets the value of the <FoodserviceItemUnitRefId> element.
java.math.BigDecimal	getItemPortionQuantity() Gets the value of the <ItemPortionQuantity> element.
java.lang.String	getItemPortionType() Gets the value of the <ItemPortionType> 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	getRefId() Gets the value of the RefId attribute.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setFoodserviceItemUnitRefId(java.lang.String value) Sets the value of the <FoodserviceItemUnitRefId> element.
void	setItemPortionQuantity(java.math.BigDecimal value) Sets the value of the <ItemPortionQuantity> element.
void	setItemPortionType(ItemPortionTypeValue value) Sets the value of the <ItemPortionType> element.
void	setItemPortionType(java.lang.String value) Sets the value of the <ItemPortionType> element as a String.
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

FoodserviceItemPortion

public FoodserviceItemPortion()

Constructor

FoodserviceItemPortion

public FoodserviceItemPortion(java.lang.String refId,
                              java.lang.String foodserviceItemUnitRefId,
                              java.math.BigDecimal itemPortionQuantity,
                              ItemPortionTypeValue itemPortionType)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this item's portion

foodserviceItemUnitRefId - GUID that identifies related item portion

itemPortionQuantity - Quantity of item portion (number of units)

itemPortionType - Type of item unit

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's portion"

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's portion"

Parameters:

value - A String object

Since:

1.5r1

getFoodserviceItemUnitRefId

public java.lang.String getFoodserviceItemUnitRefId()

Gets the value of the <FoodserviceItemUnitRefId> element.

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

Returns:

The FoodserviceItemUnitRefId element of this object.

Since:

1.5r1

setFoodserviceItemUnitRefId

public void setFoodserviceItemUnitRefId(java.lang.String value)

Sets the value of the <FoodserviceItemUnitRefId> element.

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

Parameters:

value - A String object

Since:

1.5r1

getItemPortionQuantity

public java.math.BigDecimal getItemPortionQuantity()

Gets the value of the <ItemPortionQuantity> element.

The SIF specification defines the meaning of this element as: "Quantity of item portion (number of units)"

Returns:

The ItemPortionQuantity element of this object.

Since:

1.5r1

setItemPortionQuantity

public void setItemPortionQuantity(java.math.BigDecimal value)

Sets the value of the <ItemPortionQuantity> element.

The SIF specification defines the meaning of this element as: "Quantity of item portion (number of units)"

Parameters:

value - A BigDecimal object

Since:

1.5r1

getItemPortionType

public java.lang.String getItemPortionType()

Gets the value of the <ItemPortionType> element.

The SIF specification defines the meaning of this element as: "Type of item unit"

Returns:

The ItemPortionType element of this object.

Since:

1.5r1

setItemPortionType

public void setItemPortionType(ItemPortionTypeValue value)

Sets the value of the <ItemPortionType> element.

The SIF specification defines the meaning of this element as: "Type of item unit"

Parameters:

value - A constant defined by the ItemPortionTypeValue class

Since:

1.5r1

setItemPortionType

public void setItemPortionType(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Type of item unit"

Parameters:

value - The value as a String

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: "Optional description of amount"

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: "Optional description of amount"

Parameters:

value - A String object

Since:

1.5r1