com.edustructures.sifworks.hrfin
Class FinancialAccount

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FinancialAccount
extends SIFDataObject

This object communicates information about a financial 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

FinancialAccount()
Constructor

FinancialAccount(java.lang.String refId, java.lang.String accountNumber, java.lang.String name, java.lang.String financialClassRefId, java.util.Calendar creationDate, java.util.Calendar creationTime)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getAccountNumber() Gets the value of the <AccountNumber> element.
java.util.Calendar	getCreationDate() Gets the value of the <CreationDate> element.
java.util.Calendar	getCreationTime() Gets the value of the <CreationTime> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
java.lang.String	getFinancialClassRefId() Gets the value of the <FinancialClassRefId> 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	getName() Gets the value of the <Name> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
void	setAccountNumber(java.lang.String value) Sets the value of the <AccountNumber> element.
void	setCreationDate(java.util.Calendar value) Sets the value of the <CreationDate> element.
void	setCreationTime(java.util.Calendar value) Sets the value of the <CreationTime> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setFinancialClassRefId(java.lang.String value) Sets the value of the <FinancialClassRefId> element.
void	setName(java.lang.String value) Sets the value of the <Name> 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

FinancialAccount

public FinancialAccount()

Constructor

FinancialAccount

public FinancialAccount(java.lang.String refId,
                        java.lang.String accountNumber,
                        java.lang.String name,
                        java.lang.String financialClassRefId,
                        java.util.Calendar creationDate,
                        java.util.Calendar creationTime)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this financial account.

accountNumber - Account number used for ledger.

name - Name of the account.

financialClassRefId - Financial class of the account.

creationDate - Account creation date.

creationTime - Account creation time.

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 account."

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 account."

Parameters:

value - A String object

Since:

1.5r1

getAccountNumber

public java.lang.String getAccountNumber()

Gets the value of the <AccountNumber> element.

The SIF specification defines the meaning of this element as: "Account number used for ledger."

Returns:

The AccountNumber element of this object.

Since:

1.5r1

setAccountNumber

public void setAccountNumber(java.lang.String value)

Sets the value of the <AccountNumber> element.

The SIF specification defines the meaning of this element as: "Account number used for ledger."

Parameters:

value - A String object

Since:

1.5r1

getName

public java.lang.String getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of the account."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"FinancialAccountName"
SIF2.0	"Name"

Returns:

The Name element of this object.

Since:

1.5r1

setName

public void setName(java.lang.String value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of the account."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"FinancialAccountName"
SIF2.0	"Name"

Parameters:

value - A String object

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

getFinancialClassRefId

public java.lang.String getFinancialClassRefId()

Gets the value of the <FinancialClassRefId> element.

The SIF specification defines the meaning of this element as: "Financial class of the account."

Returns:

The FinancialClassRefId element of this object.

Since:

1.5r1

setFinancialClassRefId

public void setFinancialClassRefId(java.lang.String value)

Sets the value of the <FinancialClassRefId> element.

The SIF specification defines the meaning of this element as: "Financial class of the account."

Parameters:

value - A String object

Since:

1.5r1

getCreationDate

public java.util.Calendar getCreationDate()

Gets the value of the <CreationDate> element.

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

Returns:

The CreationDate element of this object.

Since:

1.5r1

setCreationDate

public void setCreationDate(java.util.Calendar value)

Sets the value of the <CreationDate> element.

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

Parameters:

value - A Calendar object

Since:

1.5r1

getCreationTime

public java.util.Calendar getCreationTime()

Gets the value of the <CreationTime> element.

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

Returns:

The CreationTime element of this object.

Since:

1.5r1

setCreationTime

public void setCreationTime(java.util.Calendar value)

Sets the value of the <CreationTime> element.

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

Parameters:

value - A Calendar object

Since:

1.5r1