com.edustructures.sifworks.food
Class TransactionPayMethods

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<TransactionPayMethod>
                  com.edustructures.sifworks.food.TransactionPayMethods

All Implemented Interfaces:

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

public class TransactionPayMethods
extends SIFKeyedList<TransactionPayMethod>

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

TransactionPayMethods()
Constructor

TransactionPayMethods(TransactionPayMethod transactionPayMethod)
Constructor that accepts values for all mandatory fields

Method Summary

void	addTransactionPayMethod(TransactionPayMethodType type, FSAmounts amounts) Adds a new <TransactionPayMethod> repeatable element.
TransactionPayMethod	getTransactionPayMethod(TransactionPayMethodType type) Gets a TransactionPayMethod object instance.
TransactionPayMethod[]	getTransactionPayMethods() Gets all TransactionPayMethod object instances.
void	removeTransactionPayMethod(TransactionPayMethodType type) Removes a TransactionPayMethod object instance.
void	setTransactionPayMethods(TransactionPayMethod[] transactionpaymethods) Sets an array of TransactionPayMethod objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

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

TransactionPayMethods

public TransactionPayMethods()

Constructor

TransactionPayMethods

public TransactionPayMethods(TransactionPayMethod transactionPayMethod)

Constructor that accepts values for all mandatory fields

Parameters:

transactionPayMethod - Transaction method

Method Detail

addTransactionPayMethod

public void addTransactionPayMethod(TransactionPayMethodType type,
                                    FSAmounts amounts)

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

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.

Since:

1.5r1

removeTransactionPayMethod

public void removeTransactionPayMethod(TransactionPayMethodType type)

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

Parameters:

type - Identifies the TransactionPayMethod object to remove by its Type value

Since:

1.5r1

getTransactionPayMethod

public TransactionPayMethod getTransactionPayMethod(TransactionPayMethodType type)

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

Parameters:

type - Identifies the TransactionPayMethod object to return by its "Type" attribute value

Returns:

A TransactionPayMethod object

Since:

1.5r1

getTransactionPayMethods

public TransactionPayMethod[] getTransactionPayMethods()

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

Returns:

An array of TransactionPayMethod objects

Since:

1.5r1

setTransactionPayMethods

public void setTransactionPayMethods(TransactionPayMethod[] transactionpaymethods)

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

Since:

1.5r1