com.edustructures.sifworks.hrfin
Class FinancialAnnual

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FinancialAnnual
extends SIFDataObject

This object contains information about account code annual financial totals, summarized by major and/or minor account code breaks. SIF_Events are not 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

FinancialAnnual()
Constructor

FinancialAnnual(java.util.Calendar reportDate, StatePrCode stateProvinceId, java.lang.Integer fiscalYear, AnnualItems annualItems)
Constructor that accepts values for all mandatory fields

Method Summary

AnnualItems	getAnnualItems() Gets the value of the <AnnualItems> element.
java.lang.Integer	getFiscalYear() Gets the value of the <FiscalYear> 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.util.Calendar	getReportDate() Gets the value of the <ReportDate> element.
java.lang.String	getStateProvinceId() Gets the value of the <StateProvinceId> element.
void	removeAnnualItems() Removes the AnnualItems child element previously created by calling setAnnualItems
void	setAnnualItems(AnnualItems value) Sets the value of the <AnnualItems> element.
void	setFiscalYear(java.lang.Integer value) Sets the value of the <FiscalYear> element.
void	setReportDate(java.util.Calendar value) Sets the value of the <ReportDate> element.
void	setStateProvinceId(StatePrCode value) Sets the value of the <StateProvinceId> element.
void	setStateProvinceId(java.lang.String value) Sets the value of the <StateProvinceId> element as a String.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getRefId, 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

FinancialAnnual

public FinancialAnnual()

Constructor

FinancialAnnual

public FinancialAnnual(java.util.Calendar reportDate,
                       StatePrCode stateProvinceId,
                       java.lang.Integer fiscalYear,
                       AnnualItems annualItems)

Constructor that accepts values for all mandatory fields

Parameters:

reportDate - Date on which snapshot was generated.

stateProvinceId - State assigned reporting ID for district or agency

fiscalYear - Fiscal year of summary account

annualItems - Contains information about the item being summarized.

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

getReportDate

public java.util.Calendar getReportDate()

Gets the value of the <ReportDate> element.

The SIF specification defines the meaning of this element as: "Date on which snapshot was generated."

Returns:

The ReportDate element of this object.

Since:

1.5r1

setReportDate

public void setReportDate(java.util.Calendar value)

Sets the value of the <ReportDate> element.

The SIF specification defines the meaning of this element as: "Date on which snapshot was generated."

Parameters:

value - A Calendar object

Since:

1.5r1

getStateProvinceId

public java.lang.String getStateProvinceId()

Gets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "State assigned reporting ID for district or agency"

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	"StatePrId"
SIF2.0	"StateProvinceId"

Returns:

The StateProvinceId element of this object.

Since:

1.5r1

setStateProvinceId

public void setStateProvinceId(StatePrCode value)

Sets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "State assigned reporting ID for district or agency"

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	"StatePrId"
SIF2.0	"StateProvinceId"

Parameters:

value - A constant defined by the StatePrCode class

Since:

1.5r1

setStateProvinceId

public void setStateProvinceId(java.lang.String value)

Sets the value of the <StateProvinceId> element as a String.

The SIF specification defines the meaning of this element as: "State assigned reporting ID for district or agency"

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	"StatePrId"
SIF2.0	"StateProvinceId"

Parameters:

value - The value as a String

Since:

1.5r1

getFiscalYear

public java.lang.Integer getFiscalYear()

Gets the value of the <FiscalYear> element.

The SIF specification defines the meaning of this element as: "Fiscal year of summary 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	"FiscalYr"
SIF2.0	"FiscalYear"

Returns:

The FiscalYear element of this object.

Since:

1.5r1

setFiscalYear

public void setFiscalYear(java.lang.Integer value)

Sets the value of the <FiscalYear> element.

The SIF specification defines the meaning of this element as: "Fiscal year of summary 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	"FiscalYr"
SIF2.0	"FiscalYear"

Parameters:

value - A Integer object

Since:

1.5r1

setAnnualItems

public void setAnnualItems(AnnualItems value)

Sets the value of the <AnnualItems> element.

The SIF specification defines the meaning of this element as: "Contains information about the item being summarized."

Parameters:

value - A AnnualItems object

Since:

1.5r1

getAnnualItems

public AnnualItems getAnnualItems()

Gets the value of the <AnnualItems> element.

The SIF specification defines the meaning of this element as: "Contains information about the item being summarized."

Returns:

An AnnualItems object

Since:

1.5r1

removeAnnualItems

public void removeAnnualItems()

Removes the AnnualItems child element previously created by calling setAnnualItems

Since:

1.5r1