public interface FiscalPeriod extends OsidObject
A FiscalPeriod
represents a period of time on a fiscal
calendar.
Modifier and Type | Method and Description |
---|---|
DateTime |
getBudgetDeadline()
Gets the budget deadline.
|
DateTime |
getClosing()
Gets the date of the closing for this period.
|
DisplayText |
getDisplayLabel()
Gets a display label for this fiscal period which may be less formal
than the display name.
|
DateTime |
getEndDate()
Get sthe end date of this period.
|
FiscalPeriodRecord |
getFiscalPeriodRecord(Type fiscalPeriodRecordType)
Gets the fiscal period record corresponding to the given
FiscalPeriod record Type. |
long |
getFiscalYear()
Ges the fiscal year.
|
DateTime |
getPostingDeadline()
Gets the last date transactions can be posted for this period.
|
DateTime |
getStartDate()
Get sthe start date of this period.
|
boolean |
hasClosing()
Tests if this period has a closing date.
|
boolean |
hasMilestones()
Tests if this fiscal period has milestones.
|
boolean |
hasPostingDeadline()
Tests if this period has a cutoff date for posting transactions.
|
boolean |
requiresBudgetSubmission()
Tests if budgets need to be submiited for this fiscal period.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DisplayText getDisplayLabel()
mandatory
- This method must be implemented. long getFiscalYear()
mandatory
- This method must be implemented. DateTime getStartDate()
mandatory
- This method must be implemented. DateTime getEndDate()
mandatory
- This method must be implemented. boolean hasMilestones()
true
if milestones are available, false
otherwisemandatory
- This method must be implemented. boolean requiresBudgetSubmission()
true
if budgets require submission,
false
otherwiseIllegalStateException
- hasMilestones()
is false
mandatory
- This method must be implemented. DateTime getBudgetDeadline()
IllegalStateException
- hasMilestones()
or requiresBudgetSubmission()
is false
mandatory
- This method must be implemented. boolean hasPostingDeadline()
true
if a posting deadline date is available,
false
otherwiseIllegalStateException
- hasMilestones()
is false
mandatory
- This method must be implemented. DateTime getPostingDeadline()
IllegalStateException
- hasMilestones()
or hasPostingDeadline()
is false
mandatory
- This method must be implemented. boolean hasClosing()
true
if a closing date is available,
false
otherwiseIllegalStateException
- hasMilestones()
is false
mandatory
- This method must be implemented. DateTime getClosing()
IllegalStateException
- hasMilestones()
or hasClosing()
is false
mandatory
- This method must be implemented. FiscalPeriodRecord getFiscalPeriodRecord(Type fiscalPeriodRecordType) throws OperationFailedException
FiscalPeriod
record Type.
This method is used
to retrieve an object implementing the requested record. The
fiscalPeriodRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(fiscalPeriodRecordType)
is true
.fiscalPeriodRecordType
- the type of fiscal period record to
retrieveNullArgumentException
- fiscalPeriodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(fiscalPeriodRecordType)
is false
mandatory
- This method must be implemented.