OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.FiscalPeriod
Implementsosid.OsidObject
Description

A FiscalPeriod represents a period of time on a fiscal calendar.

MethodgetDisplayLabel
Description

Gets a display label for this fiscal period which may be less formal than the display name.

Returnosid.locale.DisplayTextthe display label
CompliancemandatoryThis method must be implemented.
MethodgetFiscalYear
Description

Ges the fiscal year.

Returnintegerthe fiscal year
CompliancemandatoryThis method must be implemented.
MethodgetStartDate
Description

Get sthe start date of this period.

Returnosid.calendaring.DateTimethe start date
CompliancemandatoryThis method must be implemented.
MethodgetEndDate
Description

Get sthe end date of this period.

Returnosid.calendaring.DateTimethe end date
CompliancemandatoryThis method must be implemented.
MethodhasMilestones
Description

Tests if this fiscal period has milestones.

Returnboolean true if milestones are available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodrequiresBudgetSubmission
Description

Tests if budgets need to be submiited for this fiscal period.

Returnboolean true if budgets require submission, false otherwise
ErrorsILLEGAL_STATE hasMilestones() is false
CompliancemandatoryThis method must be implemented.
MethodgetBudgetDeadline
Description

Gets the budget deadline.

Returnosid.calendaring.DateTimethe closing date
ErrorsILLEGAL_STATE hasMilestones() or requiresBudgetSubmission() is false
CompliancemandatoryThis method must be implemented.
MethodhasPostingDeadline
Description

Tests if this period has a cutoff date for posting transactions.

Returnboolean true if a posting deadline date is available, false otherwise
ErrorsILLEGAL_STATE hasMilestones() is false
CompliancemandatoryThis method must be implemented.
MethodgetPostingDeadline
Description

Gets the last date transactions can be posted for this period.

Returnosid.calendaring.DateTimethe cutoff date
ErrorsILLEGAL_STATE hasMilestones() or hasPostingDeadline() is false
CompliancemandatoryThis method must be implemented.
MethodhasClosing
Description

Tests if this period has a closing date.

Returnboolean true if a closing date is available, false otherwise
ErrorsILLEGAL_STATE hasMilestones() is false
CompliancemandatoryThis method must be implemented.
MethodgetClosing
Description

Gets the date of the closing for this period.

Returnosid.calendaring.DateTimethe closing date
ErrorsILLEGAL_STATE hasMilestones() or hasClosing() is false
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodRecord
Description

Gets the fiscal period record corresponding to the given 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 .

Parametersosid.type.TypefiscalPeriodRecordTypethe type of fiscal period record to retrieve
Returnosid.financials.records.FiscalPeriodRecordthe fiscal period record
ErrorsNULL_ARGUMENT fiscalPeriodRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(fiscalPeriodRecordType) is false
CompliancemandatoryThis method must be implemented.