com.edustructures.sifworks.food
Class PurchaseQuantities

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<PurchaseQuantity>
              com.edustructures.sifworks.food.PurchaseQuantities

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<PurchaseQuantity>, java.util.Collection<PurchaseQuantity>

public class PurchaseQuantities
extends SIFList<PurchaseQuantity>

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

PurchaseQuantities()
Constructor

PurchaseQuantities(PurchaseQuantity purchaseQuantity)
Constructor that accepts values for all mandatory fields

Method Summary

void	addPurchaseQuantity(java.lang.String foodserviceItemPortionRefId, YesNo earned, MealTypes mealType, java.math.BigDecimal value) Adds a new <PurchaseQuantity> repeatable element.
PurchaseQuantity	getPurchaseQuantity(MealTypes mealType, java.math.BigDecimal value) Gets a PurchaseQuantity object instance.
PurchaseQuantity[]	getPurchaseQuantitys() Gets all PurchaseQuantity object instances.
void	removePurchaseQuantity(MealTypes mealType, java.math.BigDecimal value) Removes a PurchaseQuantity object instance.
void	setPurchaseQuantitys(PurchaseQuantity[] purchasequantitys) Sets an array of PurchaseQuantity objects.

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

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, getKey, 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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

PurchaseQuantities

public PurchaseQuantities()

Constructor

PurchaseQuantities

public PurchaseQuantities(PurchaseQuantity purchaseQuantity)

Constructor that accepts values for all mandatory fields

Parameters:

purchaseQuantity -

Method Detail

addPurchaseQuantity

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

Adds a new <PurchaseQuantity> repeatable element. This form of setPurchaseQuantity is provided as a convenience method that is functionally equivalent to the version of setPurchaseQuantity that accepts a single PurchaseQuantity object.

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 -

Since:

2.0

removePurchaseQuantity

public void removePurchaseQuantity(MealTypes mealType,
                                   java.math.BigDecimal value)

Removes a PurchaseQuantity object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

mealType - Identifies the PurchaseQuantity object to remove by its MealType value

value - Identifies the PurchaseQuantity object to remove by its Value value

Since:

2.0

getPurchaseQuantity

public PurchaseQuantity getPurchaseQuantity(MealTypes mealType,
                                            java.math.BigDecimal value)

Gets a PurchaseQuantity object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

mealType - Identifies the PurchaseQuantity object to return by its "MealType" attribute value

value - Identifies the PurchaseQuantity object to return by its "Value" attribute value

Returns:

A PurchaseQuantity object

Since:

2.0

getPurchaseQuantitys

public PurchaseQuantity[] getPurchaseQuantitys()

Gets all PurchaseQuantity object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of PurchaseQuantity objects

Since:

2.0

setPurchaseQuantitys

public void setPurchaseQuantitys(PurchaseQuantity[] purchasequantitys)

Sets an array of PurchaseQuantity objects. All existing PurchaseQuantity instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all PurchaseQuantitys.

Since:

2.0