com.edustructures.sifworks.hrfin
Class Payment

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.hrfin.Payment

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Payment
extends SIFDataObject

This object complements the Billing object, and contains information about the payment of a billing object.

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Payment()
Constructor

Payment(java.lang.String refId, java.lang.String entityId, java.lang.String billingRefId, java.util.Calendar receivedDate, java.lang.String transactionDescription, java.math.BigDecimal receivedAmount, java.lang.String receivedTransactionId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getBillingRefId() Gets the value of the BillingRefId attribute.
java.lang.String	getEntityId() Gets the value of the <EntityId> 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.math.BigDecimal	getReceivedAmount() Gets the value of the <ReceivedAmount> element.
java.util.Calendar	getReceivedDate() Gets the value of the <ReceivedDate> element.
java.lang.String	getReceivedTransactionId() Gets the value of the <ReceivedTransactionId> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getTransactionDescription() Gets the value of the <TransactionDescription> element.
void	setBillingRefId(java.lang.String value) Sets the value of the BillingRefId attribute.
void	setEntityId(java.lang.String value) Sets the value of the <EntityId> element.
void	setReceivedAmount(java.math.BigDecimal value) Sets the value of the <ReceivedAmount> element.
void	setReceivedDate(java.util.Calendar value) Sets the value of the <ReceivedDate> element.
void	setReceivedTransactionId(java.lang.String value) Sets the value of the <ReceivedTransactionId> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setTransactionDescription(java.lang.String value) Sets the value of the <TransactionDescription> 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

Payment

public Payment()

Constructor

Payment

public Payment(java.lang.String refId,
               java.lang.String entityId,
               java.lang.String billingRefId,
               java.util.Calendar receivedDate,
               java.lang.String transactionDescription,
               java.math.BigDecimal receivedAmount,
               java.lang.String receivedTransactionId)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID for this transaction. The application that owns this object is responsible for generating this unique ID.

entityId - ID of the entity related to this billing activity (e.g. student ID, employee ID, organization, etc.)

billingRefId - A pointer back to the Billing object.

receivedDate - Date payment was received.

transactionDescription - Description of the transaction.

receivedAmount - Amount received.

receivedTransactionId - Memo transaction ID from other vendor software.

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 for this transaction. The application that owns this object is responsible for generating this unique ID."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.1

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 for this transaction. The application that owns this object is responsible for generating this unique ID."

Parameters:

value - A String object

Since:

1.1

getEntityId

public java.lang.String getEntityId()

Gets the value of the <EntityId> element.

The SIF specification defines the meaning of this element as: "ID of the entity related to this billing activity (e.g. student ID, employee ID, organization, etc.)"

Returns:

The EntityId element of this object.

Since:

1.1

setEntityId

public void setEntityId(java.lang.String value)

Sets the value of the <EntityId> element.

The SIF specification defines the meaning of this element as: "ID of the entity related to this billing activity (e.g. student ID, employee ID, organization, etc.)"

Parameters:

value - A String object

Since:

1.1

getBillingRefId

public java.lang.String getBillingRefId()

Gets the value of the BillingRefId attribute.

The SIF specification defines the meaning of this attribute as: "A pointer back to the Billing object."

Returns:

The BillingRefId attribute of this object.

Since:

2.0

setBillingRefId

public void setBillingRefId(java.lang.String value)

Sets the value of the BillingRefId attribute.

The SIF specification defines the meaning of this attribute as: "A pointer back to the Billing object."

Parameters:

value - A String object

Since:

2.0

getReceivedDate

public java.util.Calendar getReceivedDate()

Gets the value of the <ReceivedDate> element.

The SIF specification defines the meaning of this element as: "Date payment was received."

Returns:

The ReceivedDate element of this object.

Since:

1.1

setReceivedDate

public void setReceivedDate(java.util.Calendar value)

Sets the value of the <ReceivedDate> element.

The SIF specification defines the meaning of this element as: "Date payment was received."

Parameters:

value - A Calendar object

Since:

1.1

getTransactionDescription

public java.lang.String getTransactionDescription()

Gets the value of the <TransactionDescription> element.

The SIF specification defines the meaning of this element as: "Description of the transaction."

Returns:

The TransactionDescription element of this object.

Since:

1.1

setTransactionDescription

public void setTransactionDescription(java.lang.String value)

Sets the value of the <TransactionDescription> element.

The SIF specification defines the meaning of this element as: "Description of the transaction."

Parameters:

value - A String object

Since:

1.1

getReceivedAmount

public java.math.BigDecimal getReceivedAmount()

Gets the value of the <ReceivedAmount> element.

The SIF specification defines the meaning of this element as: "Amount received."

Returns:

The ReceivedAmount element of this object.

Since:

1.1

setReceivedAmount

public void setReceivedAmount(java.math.BigDecimal value)

Sets the value of the <ReceivedAmount> element.

The SIF specification defines the meaning of this element as: "Amount received."

Parameters:

value - A BigDecimal object

Since:

1.1

getReceivedTransactionId

public java.lang.String getReceivedTransactionId()

Gets the value of the <ReceivedTransactionId> element.

The SIF specification defines the meaning of this element as: "Memo transaction ID from other vendor software."

Returns:

The ReceivedTransactionId element of this object.

Since:

1.1

setReceivedTransactionId

public void setReceivedTransactionId(java.lang.String value)

Sets the value of the <ReceivedTransactionId> element.

The SIF specification defines the meaning of this element as: "Memo transaction ID from other vendor software."

Parameters:

value - A String object

Since:

1.1