com.edustructures.sifworks.hrfin
Class FinancialIncomeStatement

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FinancialIncomeStatement
extends SIFDataObject

This object communicates the income statement details for a location and an accounting period. 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

FinancialIncomeStatement()
Constructor

FinancialIncomeStatement(java.lang.String refId, java.util.Calendar generationDate, java.util.Calendar generationTime, java.lang.String locationInfoRefId, FISPeriod period, FISAmounts amounts)
Constructor that accepts values for all mandatory fields

Method Summary

FISAmounts	getAmounts() Gets the value of the <Amounts> element.
java.util.Calendar	getGenerationDate() Gets the value of the <GenerationDate> element.
java.util.Calendar	getGenerationTime() Gets the value of the <GenerationTime> 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	getLocationInfoRefId() Gets the value of the <LocationInfoRefId> element.
FISPeriod	getPeriod() Gets the value of the <Period> element.
Program	getProgram() Gets the value of the <Program> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
void	removeAmounts() Removes the Amounts child element previously created by calling setAmounts
void	removePeriod() Removes the Period child element previously created by calling setPeriod
void	removeProgram() Removes the Program child element previously created by calling setProgram
void	setAmounts(FISAmount amount) Sets the value of the <Amounts> child element.
void	setAmounts(FISAmounts value) Sets the value of the <Amounts> element.
void	setGenerationDate(java.util.Calendar value) Sets the value of the <GenerationDate> element.
void	setGenerationTime(java.util.Calendar value) Sets the value of the <GenerationTime> element.
void	setLocationInfoRefId(java.lang.String value) Sets the value of the <LocationInfoRefId> element.
void	setPeriod(java.util.Calendar startDate, java.util.Calendar endDate, java.lang.String value) Sets the value of the <Period> child element.
void	setPeriod(FISPeriod value) Sets the value of the <Period> 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.

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

FinancialIncomeStatement

public FinancialIncomeStatement()

Constructor

FinancialIncomeStatement

public FinancialIncomeStatement(java.lang.String refId,
                                java.util.Calendar generationDate,
                                java.util.Calendar generationTime,
                                java.lang.String locationInfoRefId,
                                FISPeriod period,
                                FISAmounts amounts)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this income statement.

generationDate - Generation date.

generationTime - Generation time.

locationInfoRefId - LocationInfo reference.

period - Period of the income statement.

amounts - Amount in the account.

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 income statement."

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 income statement."

Parameters:

value - A String object

Since:

1.5r1

getGenerationDate

public java.util.Calendar getGenerationDate()

Gets the value of the <GenerationDate> element.

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

Returns:

The GenerationDate element of this object.

Since:

1.5r1

setGenerationDate

public void setGenerationDate(java.util.Calendar value)

Sets the value of the <GenerationDate> element.

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

Parameters:

value - A Calendar object

Since:

1.5r1

getGenerationTime

public java.util.Calendar getGenerationTime()

Gets the value of the <GenerationTime> element.

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

Returns:

The GenerationTime element of this object.

Since:

1.5r1

setGenerationTime

public void setGenerationTime(java.util.Calendar value)

Sets the value of the <GenerationTime> element.

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

Parameters:

value - A Calendar object

Since:

1.5r1

getLocationInfoRefId

public java.lang.String getLocationInfoRefId()

Gets the value of the <LocationInfoRefId> element.

The SIF specification defines the meaning of this element as: "LocationInfo reference."

Returns:

The LocationInfoRefId element of this object.

Since:

1.5r1

setLocationInfoRefId

public void setLocationInfoRefId(java.lang.String value)

Sets the value of the <LocationInfoRefId> element.

The SIF specification defines the meaning of this element as: "LocationInfo reference."

Parameters:

value - A String object

Since:

1.5r1

setPeriod

public void setPeriod(FISPeriod value)

Sets the value of the <Period> element.

The SIF specification defines the meaning of this element as: "Period of the income statement."

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	"FISPeriod"
SIF2.0	"Period"

Parameters:

value - A FISPeriod object

Since:

1.5r1

setPeriod

public void setPeriod(java.util.Calendar startDate,
                      java.util.Calendar endDate,
                      java.lang.String value)

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

Parameters:

startDate - Start date.

endDate - End date.

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

Since:

1.5r1

getPeriod

public FISPeriod getPeriod()

Gets the value of the <Period> element.

The SIF specification defines the meaning of this element as: "Period of the income statement."

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	"FISPeriod"
SIF2.0	"Period"

Returns:

A FISPeriod object

Since:

1.5r1

removePeriod

public void removePeriod()

Removes the Period child element previously created by calling setPeriod

Since:

1.5r1

setAmounts

public void setAmounts(FISAmounts value)

Sets the value of the <Amounts> element.

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

Parameters:

value - A FISAmounts object

Since:

1.5r1

setAmounts

public void setAmounts(FISAmount amount)

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

Parameters:

amount -

Since:

1.5r1

getAmounts

public FISAmounts getAmounts()

Gets the value of the <Amounts> element.

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

Returns:

A FISAmounts 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