com.edustructures.sifworks.food
Class FoodserviceTransactionPayMethod

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FoodserviceTransactionPayMethod
extends SIFDataObject

This object communicates the funding for a given transaction. By the term funding we refer to the form of payment that is made for the transaction. 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

FoodserviceTransactionPayMethod()
Constructor

FoodserviceTransactionPayMethod(java.lang.String refId, java.lang.String foodserviceTransactionRefId, TransactionPayMethods transactionPayMethods)
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
java.lang.String	getRefId() Gets the value of the RefId attribute.
TransactionPayMethods	getTransactionPayMethods() Gets the value of the <TransactionPayMethods> element.
void	removeTransactionPayMethods() Removes the TransactionPayMethods child element previously created by calling setTransactionPayMethods
void	setFoodserviceTransactionRefId(java.lang.String value) Sets the value of the <FoodserviceTransactionRefId> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setTransactionPayMethods(TransactionPayMethods value) Sets the value of the <TransactionPayMethods> element.

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

FoodserviceTransactionPayMethod

public FoodserviceTransactionPayMethod()

Constructor

FoodserviceTransactionPayMethod

public FoodserviceTransactionPayMethod(java.lang.String refId,
                                       java.lang.String foodserviceTransactionRefId,
                                       TransactionPayMethods transactionPayMethods)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies the payment

foodserviceTransactionRefId - GUID that identifies food service transaction

transactionPayMethods - Transaction method

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 the payment"

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 the payment"

Parameters:

value - A String object

Since:

1.5r1

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"

Returns:

The FoodserviceTransactionRefId element of this object.

Since:

1.5r1

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"

Parameters:

value - A String object

Since:

1.5r1

setTransactionPayMethods

public void setTransactionPayMethods(TransactionPayMethods value)

Sets the value of the <TransactionPayMethods> element.

The SIF specification defines the meaning of this element as: "Transaction method"

Parameters:

value - A TransactionPayMethods object

Since:

1.5r1

getTransactionPayMethods

public TransactionPayMethods getTransactionPayMethods()

Gets the value of the <TransactionPayMethods> element.

The SIF specification defines the meaning of this element as: "Transaction method"

Returns:

A TransactionPayMethods object

Since:

1.5r1

removeTransactionPayMethods

public void removeTransactionPayMethods()

Removes the TransactionPayMethods child element previously created by calling setTransactionPayMethods

Since:

1.5r1