OSID Logo
OSID Specifications
financials posting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.posting.PostForm
Implementsosid.OsidObjectForm
osid.OsidAggregateableForm
Description

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

MethodgetFiscalPeriodMetadata
Description

Gets the metadata for the fiscal period.

Returnosid.Metadatametadata for the fiscal period
CompliancemandatoryThis method must be implemented.
MethodsetFiscalPeriod
Description

Sets the fiscal period.

Parametersosid.id.IdfiscalPeriodIdthe new fiscal period
ErrorsINVALID_ARGUMENT fiscalPeriodId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT fiscalPeriodId is null
CompliancemandatoryThis method must be implemented.
MethodclearFiscalPeriod
Description

Removes the fiscal period.

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

Gets the metadata for the date.

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

Sets the date.

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

Removes the date.

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

Gets the metadata for the corrected post.

Returnosid.Metadatametadata for the corrected post
CompliancemandatoryThis method must be implemented.
MethodsetCorrectedPost
Description

Sets the corrected post.

Parametersosid.id.IdpostIdthe new corrected post
ErrorsINVALID_ARGUMENT postId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT postId is null
CompliancemandatoryThis method must be implemented.
MethodclearCorrectedPost
Description

Removes the corrected post.

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

Gets the PostFormRecord corresponding to the given post record Type.

Parametersosid.type.TypepostRecordTypea post record type
Returnosid.financials.posting.records.PostFormRecordthe post form record
ErrorsNULL_ARGUMENT postRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(postRecordType) is false
CompliancemandatoryThis method must be implemented.