OSID - osid.financials.FiscalPeriod Service Interface Definition

Interface	osid.financials.FiscalPeriod
Implements	`osid.OsidObject`
Used By	`osid.financials.FiscalPeriodAdminSession`
	`osid.financials.FiscalPeriodList`
	`osid.financials.FiscalPeriodLookupSession`
	`osid.financials.Summary`
	`osid.financials.budgeting.Budget`
	`osid.financials.posting.Post`
Description	A `FiscalPeriod` represents a period of time on a fiscal calendar.
Method	getDisplayLabel
Description	Gets a display label for this fiscal period which may be less formal than the display name.
Return	`osid.locale.DisplayText`		the display label
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalYear
Description	Ges the fiscal year.
Return	`integer`		the fiscal year
Compliance	`mandatory`		This method must be implemented.
Method	getStartDate
Description	Get sthe start date of this period.
Return	`osid.calendaring.DateTime`		the start date
Compliance	`mandatory`		This method must be implemented.
Method	getEndDate
Description	Get sthe end date of this period.
Return	`osid.calendaring.DateTime`		the end date
Compliance	`mandatory`		This method must be implemented.
Method	hasMilestones
Description	Tests if this fiscal period has milestones.
Return	`boolean`		`true` if milestones are available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	requiresBudgetSubmission
Description	Tests if budgets need to be submiited for this fiscal period.
Return	`boolean`		`true` if budgets require submission, `false` otherwise
Errors	ILLEGAL_STATE		`hasMilestones()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetDeadline
Description	Gets the budget deadline.
Return	`osid.calendaring.DateTime`		the closing date
Errors	ILLEGAL_STATE		`hasMilestones()` or `requiresBudgetSubmission()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasPostingDeadline
Description	Tests if this period has a cutoff date for posting transactions.
Return	`boolean`		`true` if a posting deadline date is available, `false` otherwise
Errors	ILLEGAL_STATE		`hasMilestones()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getPostingDeadline
Description	Gets the last date transactions can be posted for this period.
Return	`osid.calendaring.DateTime`		the cutoff date
Errors	ILLEGAL_STATE		`hasMilestones()` or `hasPostingDeadline()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasClosing
Description	Tests if this period has a closing date.
Return	`boolean`		`true` if a closing date is available, `false` otherwise
Errors	ILLEGAL_STATE		`hasMilestones()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getClosing
Description	Gets the date of the closing for this period.
Return	`osid.calendaring.DateTime`		the closing date
Errors	ILLEGAL_STATE		`hasMilestones()` or `hasClosing()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodRecord
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`.
Parameters	`osid.type.Type`	`fiscalPeriodRecordType`	the type of fiscal period record to retrieve
Return	`osid.financials.records.FiscalPeriodRecord`		the fiscal period record
Errors	NULL_ARGUMENT		`fiscalPeriodRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(fiscalPeriodRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.