com.edustructures.sifworks.hrfin
Class AccountingPeriod

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AccountingPeriod
extends SIFDataObject

This object defines an accounting period within a fiscal year. 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

AccountingPeriod()
Constructor

AccountingPeriod(java.lang.String refId, java.lang.String name, java.lang.String fiscalYearRefId, java.util.Calendar startDate, java.util.Calendar endDate)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the <Description> element.
java.util.Calendar	getEndDate() Gets the value of the <EndDate> element.
java.lang.String	getFiscalYearRefId() Gets the value of the <FiscalYearRefId> 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.
java.util.Calendar	getStartDate() Gets the value of the <StartDate> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setEndDate(java.util.Calendar value) Sets the value of the <EndDate> element.
void	setFiscalYearRefId(java.lang.String value) Sets the value of the <FiscalYearRefId> 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.
void	setStartDate(java.util.Calendar value) Sets the value of the <StartDate> 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

AccountingPeriod

public AccountingPeriod()

Constructor

AccountingPeriod

public AccountingPeriod(java.lang.String refId,
                        java.lang.String name,
                        java.lang.String fiscalYearRefId,
                        java.util.Calendar startDate,
                        java.util.Calendar endDate)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this accounting period.

name - Name of the accounting period.

fiscalYearRefId - Fiscal year to which this accounting period belongs.

startDate - Start date of the accounting period.

endDate - End date of the accounting period.

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 accounting period."

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 accounting period."

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 accounting period."

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	"AccountingPeriodName"
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 accounting period."

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	"AccountingPeriodName"
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

getFiscalYearRefId

public java.lang.String getFiscalYearRefId()

Gets the value of the <FiscalYearRefId> element.

The SIF specification defines the meaning of this element as: "Fiscal year to which this accounting period belongs."

Returns:

The FiscalYearRefId element of this object.

Since:

1.5r1

setFiscalYearRefId

public void setFiscalYearRefId(java.lang.String value)

Sets the value of the <FiscalYearRefId> element.

The SIF specification defines the meaning of this element as: "Fiscal year to which this accounting period belongs."

Parameters:

value - A String object

Since:

1.5r1

getStartDate

public java.util.Calendar getStartDate()

Gets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "Start date of the accounting period."

Returns:

The StartDate element of this object.

Since:

1.5r1

setStartDate

public void setStartDate(java.util.Calendar value)

Sets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "Start date of the accounting period."

Parameters:

value - A Calendar object

Since:

1.5r1

getEndDate

public java.util.Calendar getEndDate()

Gets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "End date of the accounting period."

Returns:

The EndDate element of this object.

Since:

1.5r1

setEndDate

public void setEndDate(java.util.Calendar value)

Sets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "End date of the accounting period."

Parameters:

value - A Calendar object

Since:

1.5r1