OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.FiscalPeriodForm
Implementsosid.OsidObjectForm
Description

This is the form for creating and updating FiscalPeriods. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the FiscalPeriodAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetDisplayLabelMetadata
Description

Gets the metadata for a display label.

Returnosid.Metadatametadata for the display label
CompliancemandatoryThis method must be implemented.
MethodsetDisplayLabel
Description

Sets the display label.

Parametersstringlabelthe new display label
ErrorsINVALID_ARGUMENT label is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT label is null
CompliancemandatoryThis method must be implemented.
MethodclearDisplayLabel
Description

Removes the display label.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetFiscalYearMetadata
Description

Gets the metadata for a fiscal year.

Returnosid.Metadatametadata for the fiscal year
CompliancemandatoryThis method must be implemented.
MethodsetFiscalYear
Description

Sets the fiscal year.

Parametersintegeryearthe new fiscal year
ErrorsINVALID_ARGUMENT year is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearFiscalYear
Description

Removes the fiscal year.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetStartDateMetadata
Description

Gets the metadata for the start date.

Returnosid.Metadatametadata for the start date
CompliancemandatoryThis method must be implemented.
MethodsetStartDate
Description

Sets the start date.

Parametersosid.calendaring.DateTimedatethe new start date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearStartDate
Description

Removes the start date.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetEndDateMetadata
Description

Gets the metadata for the end date.

Returnosid.Metadatametadata for the end date
CompliancemandatoryThis method must be implemented.
MethodsetEndDate
Description

Sets the end date.

Parametersosid.calendaring.DateTimedatethe new end date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearEndDate
Description

Removes the end date.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetBudgetDeadlineMetadata
Description

Gets the metadata for the budget deadline.

Returnosid.Metadatametadata for the budget deadline
CompliancemandatoryThis method must be implemented.
MethodsetBudgetDeadline
Description

Sets the budget deadline.

Parametersosid.calendaring.DateTimedatethe new budget deadline
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearBudgetDeadline
Description

Removes the budget deadline.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPostingDeadlineMetadata
Description

Gets the metadata for the posting deadline.

Returnosid.Metadatametadata for the posting deadline
CompliancemandatoryThis method must be implemented.
MethodsetPostingDeadline
Description

Sets the posting deadline.

Parametersosid.calendaring.DateTimedatethe new posting deadline
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearPostingDeadline
Description

Removes the posting deadline.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetClosingMetadata
Description

Gets the metadata for the closing date.

Returnosid.Metadatametadata for the closing date
CompliancemandatoryThis method must be implemented.
MethodsetClosing
Description

Sets the closing date.

Parametersosid.calendaring.DateTimedatethe new closting date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearClosing
Description

Removes the closting date.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodFormRecord
Description

Gets the FiscalPeriodFormRecord corresponding to the given fiscal period record Type.

Parametersosid.type.TypefiscalPeriodRecordTypea fiscal period record type
Returnosid.financials.records.FiscalPeriodFormRecordthe fiscal period form record
ErrorsNULL_ARGUMENT fiscalPeriodRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(fiscalPeriodRecordType) is false
CompliancemandatoryThis method must be implemented.