com.edustructures.sifworks.food
Class FoodservicePurchaseTransaction

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFDataObject
              extended by com.edustructures.sifworks.food.FoodservicePurchaseTransaction
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class FoodservicePurchaseTransaction
extends SIFDataObject

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
FoodservicePurchaseTransaction()
          Constructor
FoodservicePurchaseTransaction(java.lang.String refId, java.lang.String foodserviceTransactionRefId, PurchaseQuantities purchaseQuantities)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 java.lang.String getFoodserviceTransactionRefId()
          Gets the value of the <FoodserviceTransactionRefId> 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
 PurchaseQuantities getPurchaseQuantities()
          Gets the value of the <PurchaseQuantities> element.
 java.lang.String getRefId()
          Gets the value of the RefId attribute.
 void removePurchaseQuantities()
          Removes the PurchaseQuantities child element previously created by calling setPurchaseQuantities
 void setFoodserviceTransactionRefId(java.lang.String value)
          Sets the value of the <FoodserviceTransactionRefId> element.
 void setPurchaseQuantities(PurchaseQuantities value)
          Sets the value of the <PurchaseQuantities> 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

FoodservicePurchaseTransaction

public FoodservicePurchaseTransaction()
Constructor


FoodservicePurchaseTransaction

public FoodservicePurchaseTransaction(java.lang.String refId,
                                      java.lang.String foodserviceTransactionRefId,
                                      PurchaseQuantities purchaseQuantities)
Constructor that accepts values for all mandatory fields

Parameters:
refId - GUID that identifies purchase transaction
foodserviceTransactionRefId - GUID that identifies food service transaction in which this purchase was made
purchaseQuantities -
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 purchase transaction"

Overrides:
getRefId in class SIFDataObject
Returns:
The RefId attribute of this object.
Since:
2.0

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 purchase transaction"

Parameters:
value - A String object
Since:
2.0

getFoodserviceTransactionRefId

public java.lang.String getFoodserviceTransactionRefId()
Gets the value of the <FoodserviceTransactionRefId> element.

The SIF specification defines the meaning of this element as: "GUID that identifies food service transaction in which this purchase was made"

Returns:
The FoodserviceTransactionRefId element of this object.
Since:
2.0

setFoodserviceTransactionRefId

public void setFoodserviceTransactionRefId(java.lang.String value)
Sets the value of the <FoodserviceTransactionRefId> element.

The SIF specification defines the meaning of this element as: "GUID that identifies food service transaction in which this purchase was made"

Parameters:
value - A String object
Since:
2.0

setPurchaseQuantities

public void setPurchaseQuantities(PurchaseQuantities value)
Sets the value of the <PurchaseQuantities> element.

Parameters:
value - A PurchaseQuantities object
Since:
2.0

getPurchaseQuantities

public PurchaseQuantities getPurchaseQuantities()
Gets the value of the <PurchaseQuantities> element.

Returns:
A PurchaseQuantities object
Since:
2.0

removePurchaseQuantities

public void removePurchaseQuantities()
Removes the PurchaseQuantities child element previously created by calling setPurchaseQuantities

Since:
2.0


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.