com.edustructures.sifworks.food
Class FoodserviceTransactionDetails

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FoodserviceTransactionDetails
extends SIFDataObject

This object gives the transaction distribution for food service transactions of type other than "Purchase". So, this object can be requested for transactions of type "Prepayment", "Repayment", "Refund", "Adjustment". 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

FoodserviceTransactionDetails()
Constructor

FoodserviceTransactionDetails(java.lang.String refId, java.lang.String foodserviceTransactionRefId, FSAmounts amounts)
Constructor that accepts values for all mandatory fields

Method Summary

FSAmounts	getAmounts() Gets the value of the <Amounts> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
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.
void	removeAmounts() Removes the Amounts child element previously created by calling setAmounts
void	setAmounts(FSAmounts value) Sets the value of the <Amounts> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
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.

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

FoodserviceTransactionDetails

public FoodserviceTransactionDetails()

Constructor

FoodserviceTransactionDetails

public FoodserviceTransactionDetails(java.lang.String refId,
                                     java.lang.String foodserviceTransactionRefId,
                                     FSAmounts amounts)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies transaction details

foodserviceTransactionRefId - GUID that identifies food service transaction

amounts - Amount. This amount refers to the funds being directed inwards/ outwards from the customer's account. That is: these amounts reflect the changes to the account balances.

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

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

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

setAmounts

public void setAmounts(FSAmounts value)

Sets the value of the <Amounts> element.

The SIF specification defines the meaning of this element as: "Amount. This amount refers to the funds being directed inwards/ outwards from the customer's account. That is: these amounts reflect the changes to the account balances."

Parameters:

value - A FSAmounts object

Since:

1.5r1

getAmounts

public FSAmounts getAmounts()

Gets the value of the <Amounts> element.

The SIF specification defines the meaning of this element as: "Amount. This amount refers to the funds being directed inwards/ outwards from the customer's account. That is: these amounts reflect the changes to the account balances."

Returns:

A FSAmounts object

Since:

1.5r1

removeAmounts

public void removeAmounts()

Removes the Amounts child element previously created by calling setAmounts

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: "Description"

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: "Description"

Parameters:

value - A String object

Since:

1.5r1