com.edustructures.sifworks.hrfin
Class AnnualItem

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.hrfin.AnnualItem

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AnnualItem
extends SIFElement

Contains information about the item being summarized.

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

AnnualItem()
Constructor

AnnualItem(AccountClass accountType, FundType fundType, java.lang.String function, java.math.BigDecimal amount)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getAccountType() Gets the value of the <AccountType> element.
java.math.BigDecimal	getAmount() Gets the value of the <Amount> element.
java.lang.String	getExpenditureArea() Gets the value of the <ExpenditureArea> element.
java.lang.String	getFunction() Gets the value of the <Function> element.
java.lang.String	getFundType() Gets the value of the <FundType> element.
java.lang.String	getGLAmountType() Gets the value of the <GLAmountType> element.
java.lang.String	getInstructionalProgram() Gets the value of the <InstructionalProgram> 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	getObject() Gets the value of the <Object> element.
java.lang.String	getSpecialAmountType() Gets the value of the <SpecialAmountType> element.
java.lang.String	getStateProvinceId() Gets the value of the <StateProvinceId> element.
void	setAccountType(AccountClass value) Sets the value of the <AccountType> element.
void	setAccountType(java.lang.String value) Sets the value of the <AccountType> element as a String.
void	setAmount(java.math.BigDecimal value) Sets the value of the <Amount> element.
void	setExpenditureArea(ExpenditureAreaValue value) Sets the value of the <ExpenditureArea> element.
void	setExpenditureArea(java.lang.String value) Sets the value of the <ExpenditureArea> element as a String.
void	setFunction(java.lang.String value) Sets the value of the <Function> element.
void	setFundType(FundType value) Sets the value of the <FundType> element.
void	setFundType(java.lang.String value) Sets the value of the <FundType> element as a String.
void	setGLAmountType(GLAmountType value) Sets the value of the <GLAmountType> element.
void	setGLAmountType(java.lang.String value) Sets the value of the <GLAmountType> element as a String.
void	setInstructionalProgram(java.lang.String value) Sets the value of the <InstructionalProgram> element.
void	setObject(java.lang.String value) Sets the value of the <Object> element.
void	setSpecialAmountType(SpecialAmountType value) Sets the value of the <SpecialAmountType> element.
void	setSpecialAmountType(java.lang.String value) Sets the value of the <SpecialAmountType> element as a String.
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.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, 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

AnnualItem

public AnnualItem()

Constructor

AnnualItem

public AnnualItem(AccountClass accountType,
                  FundType fundType,
                  java.lang.String function,
                  java.math.BigDecimal amount)

Constructor that accepts values for all mandatory fields

Parameters:

accountType - Classification of budgetary account code summary

fundType - Is the account a general or special account code designation?

function - Function break in account code for summarization.

amount - Summarized amount.

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

getAccountType

public java.lang.String getAccountType()

Gets the value of the <AccountType> element.

The SIF specification defines the meaning of this element as: "Classification of budgetary account code summary"

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	"AcctType"
SIF2.0	"AccountType"

Returns:

The AccountType element of this object.

Since:

1.5r1

setAccountType

public void setAccountType(AccountClass value)

Sets the value of the <AccountType> element.

The SIF specification defines the meaning of this element as: "Classification of budgetary account code summary"

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	"AcctType"
SIF2.0	"AccountType"

Parameters:

value - A constant defined by the AccountClass class

Since:

1.5r1

setAccountType

public void setAccountType(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Classification of budgetary account code summary"

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	"AcctType"
SIF2.0	"AccountType"

Parameters:

value - The value as a String

Since:

1.5r1

getFundType

public java.lang.String getFundType()

Gets the value of the <FundType> element.

The SIF specification defines the meaning of this element as: "Is the account a general or special account code designation?"

Returns:

The FundType element of this object.

Since:

1.5r1

setFundType

public void setFundType(FundType value)

Sets the value of the <FundType> element.

The SIF specification defines the meaning of this element as: "Is the account a general or special account code designation?"

Parameters:

value - A constant defined by the FundType class

Since:

1.5r1

setFundType

public void setFundType(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Is the account a general or special account code designation?"

Parameters:

value - The value as a String

Since:

1.5r1

getExpenditureArea

public java.lang.String getExpenditureArea()

Gets the value of the <ExpenditureArea> element.

The SIF specification defines the meaning of this element as: "Relative area in which the expenditure was used."

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	"ExpArea"
SIF2.0	"ExpenditureArea"

Returns:

The ExpenditureArea element of this object.

Since:

1.5r1

setExpenditureArea

public void setExpenditureArea(ExpenditureAreaValue value)

Sets the value of the <ExpenditureArea> element.

The SIF specification defines the meaning of this element as: "Relative area in which the expenditure was used."

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	"ExpArea"
SIF2.0	"ExpenditureArea"

Parameters:

value - A constant defined by the ExpenditureAreaValue class

Since:

1.5r1

setExpenditureArea

public void setExpenditureArea(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Relative area in which the expenditure was used."

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	"ExpArea"
SIF2.0	"ExpenditureArea"

Parameters:

value - The value as a String

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 ID for the relative area in which the expenditure/revenue was used."

Returns:

The StateProvinceId element of this object.

Since:

2.0

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 ID for the relative area in which the expenditure/revenue was used."

Parameters:

value - A constant defined by the StatePrCode class

Since:

2.0

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 ID for the relative area in which the expenditure/revenue was used."

Parameters:

value - The value as a String

Since:

2.0

getFunction

public java.lang.String getFunction()

Gets the value of the <Function> element.

The SIF specification defines the meaning of this element as: "Function break in account code for summarization."

Returns:

The Function element of this object.

Since:

1.5r1

setFunction

public void setFunction(java.lang.String value)

Sets the value of the <Function> element.

The SIF specification defines the meaning of this element as: "Function break in account code for summarization."

Parameters:

value - A String object

Since:

1.5r1

getObject

public java.lang.String getObject()

Gets the value of the <Object> element.

The SIF specification defines the meaning of this element as: "Object break in account code for summarization."

Returns:

The Object element of this object.

Since:

1.5r1

setObject

public void setObject(java.lang.String value)

Sets the value of the <Object> element.

The SIF specification defines the meaning of this element as: "Object break in account code for summarization."

Parameters:

value - A String object

Since:

1.5r1

getInstructionalProgram

public java.lang.String getInstructionalProgram()

Gets the value of the <InstructionalProgram> element.

The SIF specification defines the meaning of this element as: "Instructional program break in account code for summarization"

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	"InstProgram"
SIF2.0	"InstructionalProgram"

Returns:

The InstructionalProgram element of this object.

Since:

1.5r1

setInstructionalProgram

public void setInstructionalProgram(java.lang.String value)

Sets the value of the <InstructionalProgram> element.

The SIF specification defines the meaning of this element as: "Instructional program break in account code for summarization"

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	"InstProgram"
SIF2.0	"InstructionalProgram"

Parameters:

value - A String object

Since:

1.5r1

getAmount

public java.math.BigDecimal getAmount()

Gets the value of the <Amount> element.

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

Returns:

The Amount element of this object.

Since:

1.5r1

setAmount

public void setAmount(java.math.BigDecimal value)

Sets the value of the <Amount> element.

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

Parameters:

value - A BigDecimal object

Since:

1.5r1

getSpecialAmountType

public java.lang.String getSpecialAmountType()

Gets the value of the <SpecialAmountType> element.

The SIF specification defines the meaning of this element as: "With regard to regional/local education service agencies report of "special" account code information, the account code summarization can be classified as:"

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	"SpecAmtType"
SIF2.0	"SpecialAmountType"

Returns:

The SpecialAmountType element of this object.

Since:

1.5r1

setSpecialAmountType

public void setSpecialAmountType(SpecialAmountType value)

Sets the value of the <SpecialAmountType> element.

The SIF specification defines the meaning of this element as: "With regard to regional/local education service agencies report of "special" account code information, the account code summarization can be classified as:"

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	"SpecAmtType"
SIF2.0	"SpecialAmountType"

Parameters:

value - A constant defined by the SpecialAmountType class

Since:

1.5r1

setSpecialAmountType

public void setSpecialAmountType(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "With regard to regional/local education service agencies report of "special" account code information, the account code summarization can be classified as:"

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	"SpecAmtType"
SIF2.0	"SpecialAmountType"

Parameters:

value - The value as a String

Since:

1.5r1

getGLAmountType

public java.lang.String getGLAmountType()

Gets the value of the <GLAmountType> element.

The SIF specification defines the meaning of this element as: "With regard to an account code grouping classified as a General Ledger 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	"GLAmtType"
SIF2.0	"GLAmountType"

Returns:

The GLAmountType element of this object.

Since:

1.5r1

setGLAmountType

public void setGLAmountType(GLAmountType value)

Sets the value of the <GLAmountType> element.

The SIF specification defines the meaning of this element as: "With regard to an account code grouping classified as a General Ledger 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	"GLAmtType"
SIF2.0	"GLAmountType"

Parameters:

value - A constant defined by the GLAmountType class

Since:

1.5r1

setGLAmountType

public void setGLAmountType(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "With regard to an account code grouping classified as a General Ledger 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	"GLAmtType"
SIF2.0	"GLAmountType"

Parameters:

value - The value as a String

Since:

1.5r1