com.edustructures.sifworks.food
Class TransactionPayMethod

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.food.TransactionPayMethod

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TransactionPayMethod
extends SIFKeyedElement

Transaction method

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

TransactionPayMethod()
Constructor

TransactionPayMethod(TransactionPayMethodType type, FSAmounts amounts)
Constructor that accepts values for all mandatory fields

Method Summary

void	addAmounts(FSAmounts value) Adds a new <Amounts> child element.
FSAmounts[]	getAmountses() Gets all FSAmounts object instances.
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	getType() Gets the value of the Type attribute.
void	setAmountses(FSAmounts[] amountses) Sets an array of FSAmounts objects.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.
void	setType(TransactionPayMethodType value) Sets the value of the Type attribute.

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

TransactionPayMethod

public TransactionPayMethod()

Constructor

TransactionPayMethod

public TransactionPayMethod(TransactionPayMethodType type,
                            FSAmounts amounts)

Constructor that accepts values for all mandatory fields

Parameters:

type - This refers to the way the payment was made.

amounts - AmountThis amount is the form of the incoming funds for this transaction. For example; the payment can be made by a credit card.

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

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "This refers to the way the payment was made."

Returns:

The Type attribute of this object.

Since:

1.5r1

setType

public void setType(TransactionPayMethodType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "This refers to the way the payment was made."

Parameters:

value - A constant defined by the TransactionPayMethodType class

Since:

1.5r1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

The SIF specification defines the meaning of this attribute as: "This refers to the way the payment was made."

Parameters:

value - The value as a String

Since:

1.5r1

addAmounts

public void addAmounts(FSAmounts value)

Adds a new <Amounts> child element.

The SIF specification defines the meaning of this element as: "AmountThis amount is the form of the incoming funds for this transaction. For example; the payment can be made by a credit card."

Parameters:

value - A FSAmounts object

Since:

1.5r1

getAmountses

public FSAmounts[] getAmountses()

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

Returns:

An array of FSAmounts objects

Since:

1.5r1

setAmountses

public void setAmountses(FSAmounts[] amountses)

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

Since:

1.5r1