com.edustructures.sifworks.food
Class PurchaseQuantity

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.food.PurchaseQuantity

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class PurchaseQuantity
extends SIFElement

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

PurchaseQuantity()
Constructor

PurchaseQuantity(java.lang.String foodserviceItemPortionRefId, YesNo earned, MealTypes mealType, java.math.BigDecimal value)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getEarned() Gets the value of the Earned attribute.
java.lang.String	getFoodserviceItemPortionRefId() Gets the value of the FoodserviceItemPortionRefId attribute.
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	getMealType() Gets the value of the <MealType> element.
java.math.BigDecimal	getValue() Gets the value of the <Value> element.
void	setEarned(java.lang.String value) Sets the value of the Earned attribute as a String.
void	setEarned(YesNo value) Sets the value of the Earned attribute.
void	setFoodserviceItemPortionRefId(java.lang.String value) Sets the value of the FoodserviceItemPortionRefId attribute.
void	setMealType(MealTypes value) Sets the value of the <MealType> element.
void	setMealType(java.lang.String value) Sets the value of the <MealType> element as a String.
void	setValue(java.math.BigDecimal value) Sets the value of the <Value> element.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, 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

Constructor Detail

PurchaseQuantity

public PurchaseQuantity()

Constructor

PurchaseQuantity

public PurchaseQuantity(java.lang.String foodserviceItemPortionRefId,
                        YesNo earned,
                        MealTypes mealType,
                        java.math.BigDecimal value)

Constructor that accepts values for all mandatory fields

Parameters:

foodserviceItemPortionRefId - Item portion amount

earned - Identifies whether the item being purchased is earned i.e., at no cost to the buyer. It is used when FoodserviceTransaction object's TransactionType element has the value "Purchase".

mealType -

value -

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

getFoodserviceItemPortionRefId

public java.lang.String getFoodserviceItemPortionRefId()

Gets the value of the FoodserviceItemPortionRefId attribute.

The SIF specification defines the meaning of this attribute as: "Item portion amount"

Returns:

The FoodserviceItemPortionRefId attribute of this object.

Since:

2.0

setFoodserviceItemPortionRefId

public void setFoodserviceItemPortionRefId(java.lang.String value)

Sets the value of the FoodserviceItemPortionRefId attribute.

The SIF specification defines the meaning of this attribute as: "Item portion amount"

Parameters:

value - A String object

Since:

2.0

getEarned

public java.lang.String getEarned()

Gets the value of the Earned attribute.

The SIF specification defines the meaning of this attribute as: "Identifies whether the item being purchased is earned i.e., at no cost to the buyer. It is used when FoodserviceTransaction object's TransactionType element has the value "Purchase"."

Returns:

The Earned attribute of this object.

Since:

2.0

setEarned

public void setEarned(YesNo value)

Sets the value of the Earned attribute.

The SIF specification defines the meaning of this attribute as: "Identifies whether the item being purchased is earned i.e., at no cost to the buyer. It is used when FoodserviceTransaction object's TransactionType element has the value "Purchase"."

Parameters:

value - A constant defined by the YesNo class

Since:

2.0

setEarned

public void setEarned(java.lang.String value)

Sets the value of the Earned attribute as a String.

The SIF specification defines the meaning of this attribute as: "Identifies whether the item being purchased is earned i.e., at no cost to the buyer. It is used when FoodserviceTransaction object's TransactionType element has the value "Purchase"."

Parameters:

value - The value as a String

Since:

2.0

getMealType

public java.lang.String getMealType()

Gets the value of the <MealType> element.

Returns:

The MealType element of this object.

Since:

2.0

setMealType

public void setMealType(MealTypes value)

Sets the value of the <MealType> element.

Parameters:

value - A constant defined by the MealTypes class

Since:

2.0

setMealType

public void setMealType(java.lang.String value)

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

Parameters:

value - The value as a String

Since:

2.0

getValue

public java.math.BigDecimal getValue()

Gets the value of the <Value> element.

Returns:

The Value element of this object.

Since:

2.0

setValue

public void setValue(java.math.BigDecimal value)

Sets the value of the <Value> element.

Parameters:

value - A BigDecimal object

Since:

2.0