Interface | osid.financials.FiscalPeriodForm | ||
---|---|---|---|
Implements | osid.OsidObjectForm | ||
Description |
This is the form for creating and updating | ||
Method | getDisplayLabelMetadata | ||
Description |
Gets the metadata for a display label. | ||
Return | osid.Metadata | metadata for the display label | |
Compliance | mandatory | This method must be implemented. | |
Method | setDisplayLabel | ||
Description |
Sets the display label. | ||
Parameters | string | label | the new display label |
Errors | INVALID_ARGUMENT | label is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | label is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearDisplayLabel | ||
Description |
Removes the display label. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalYearMetadata | ||
Description |
Gets the metadata for a fiscal year. | ||
Return | osid.Metadata | metadata for the fiscal year | |
Compliance | mandatory | This method must be implemented. | |
Method | setFiscalYear | ||
Description |
Sets the fiscal year. | ||
Parameters | integer | year | the new fiscal year |
Errors | INVALID_ARGUMENT | year is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearFiscalYear | ||
Description |
Removes the fiscal year. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getStartDateMetadata | ||
Description |
Gets the metadata for the start date. | ||
Return | osid.Metadata | metadata for the start date | |
Compliance | mandatory | This method must be implemented. | |
Method | setStartDate | ||
Description |
Sets the start date. | ||
Parameters | osid.calendaring.DateTime | date | the new start date |
Errors | INVALID_ARGUMENT | date is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | date is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearStartDate | ||
Description |
Removes the start date. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getEndDateMetadata | ||
Description |
Gets the metadata for the end date. | ||
Return | osid.Metadata | metadata for the end date | |
Compliance | mandatory | This method must be implemented. | |
Method | setEndDate | ||
Description |
Sets the end date. | ||
Parameters | osid.calendaring.DateTime | date | the new end date |
Errors | INVALID_ARGUMENT | date is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | date is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearEndDate | ||
Description |
Removes the end date. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetDeadlineMetadata | ||
Description |
Gets the metadata for the budget deadline. | ||
Return | osid.Metadata | metadata for the budget deadline | |
Compliance | mandatory | This method must be implemented. | |
Method | setBudgetDeadline | ||
Description |
Sets the budget deadline. | ||
Parameters | osid.calendaring.DateTime | date | the new budget deadline |
Errors | INVALID_ARGUMENT | date is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | date is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearBudgetDeadline | ||
Description |
Removes the budget deadline. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getPostingDeadlineMetadata | ||
Description |
Gets the metadata for the posting deadline. | ||
Return | osid.Metadata | metadata for the posting deadline | |
Compliance | mandatory | This method must be implemented. | |
Method | setPostingDeadline | ||
Description |
Sets the posting deadline. | ||
Parameters | osid.calendaring.DateTime | date | the new posting deadline |
Errors | INVALID_ARGUMENT | date is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | date is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearPostingDeadline | ||
Description |
Removes the posting deadline. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getClosingMetadata | ||
Description |
Gets the metadata for the closing date. | ||
Return | osid.Metadata | metadata for the closing date | |
Compliance | mandatory | This method must be implemented. | |
Method | setClosing | ||
Description |
Sets the closing date. | ||
Parameters | osid.calendaring.DateTime | date | the new closting date |
Errors | INVALID_ARGUMENT | date is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | date is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearClosing | ||
Description |
Removes the closting date. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalPeriodFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | fiscalPeriodRecordType | a fiscal period record type |
Return | osid.financials.records.FiscalPeriodFormRecord | the fiscal period form 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. |