com.edustructures.sifworks.hrfin
Class FinancialTransaction

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FinancialTransaction
extends SIFDataObject

This object communicates a financial transaction. A transaction can be for the daily food sales revenue account. 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

FinancialTransaction()
Constructor

FinancialTransaction(java.lang.String refId, java.util.Calendar transactionDate, java.util.Calendar transactionTime, FTAmounts amounts)
Constructor that accepts values for all mandatory fields

Method Summary

FTAmounts	getAmounts() Gets the value of the <Amounts> element.
java.lang.String	getDescription() Gets the value of the <Description> 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
Program	getProgram() Gets the value of the <Program> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.util.Calendar	getTransactionDate() Gets the value of the <TransactionDate> element.
java.util.Calendar	getTransactionTime() Gets the value of the <TransactionTime> element.
void	removeAmounts() Removes the Amounts child element previously created by calling setAmounts
void	removeProgram() Removes the Program child element previously created by calling setProgram
void	setAmounts(FTAmounts value) Sets the value of the <Amounts> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setProgram(FinancialProgram type, java.lang.String value) Sets the value of the <Program> child element.
void	setProgram(Program value) Sets the value of the <Program> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setTransactionDate(java.util.Calendar value) Sets the value of the <TransactionDate> element.
void	setTransactionTime(java.util.Calendar value) Sets the value of the <TransactionTime> 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

FinancialTransaction

public FinancialTransaction()

Constructor

FinancialTransaction

public FinancialTransaction(java.lang.String refId,
                            java.util.Calendar transactionDate,
                            java.util.Calendar transactionTime,
                            FTAmounts amounts)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this financial transaction.

transactionDate - Transaction date.

transactionTime - Transaction time.

amounts - Dollar amount of the transaction.

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 this financial transaction."

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 this financial transaction."

Parameters:

value - A String object

Since:

1.5r1

getTransactionDate

public java.util.Calendar getTransactionDate()

Gets the value of the <TransactionDate> element.

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

Returns:

The TransactionDate element of this object.

Since:

1.5r1

setTransactionDate

public void setTransactionDate(java.util.Calendar value)

Sets the value of the <TransactionDate> element.

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

Parameters:

value - A Calendar object

Since:

1.5r1

getTransactionTime

public java.util.Calendar getTransactionTime()

Gets the value of the <TransactionTime> element.

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

Returns:

The TransactionTime element of this object.

Since:

1.5r1

setTransactionTime

public void setTransactionTime(java.util.Calendar value)

Sets the value of the <TransactionTime> element.

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

Parameters:

value - A Calendar object

Since:

1.5r1

setAmounts

public void setAmounts(FTAmounts value)

Sets the value of the <Amounts> element.

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

Parameters:

value - A FTAmounts object

Since:

1.5r1

getAmounts

public FTAmounts getAmounts()

Gets the value of the <Amounts> element.

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

Returns:

A FTAmounts object

Since:

1.5r1

removeAmounts

public void removeAmounts()

Removes the Amounts child element previously created by calling setAmounts

Since:

1.5r1

setProgram

public void setProgram(Program value)

Sets the value of the <Program> element.

The SIF specification defines the meaning of this element as: "See 5.1.23 Program."

Parameters:

value - A Program object

Since:

1.5r1

setProgram

public void setProgram(FinancialProgram type,
                       java.lang.String value)

Sets the value of the <Program> child element. This form of setProgram is provided as a convenience method that is functionally equivalent to the version of setProgram that accepts a single Program object.

Parameters:

type - The type of the program. Type identifies the list of values.

value - Gets or sets the content value of the <Program> element

Since:

1.5r1

getProgram

public Program getProgram()

Gets the value of the <Program> element.

The SIF specification defines the meaning of this element as: "See 5.1.23 Program."

Returns:

A Program object

Since:

1.5r1

removeProgram

public void removeProgram()

Removes the Program child element previously created by calling setProgram

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