OSID - osid.financials.posting.PostForm Service Interface Definition

Interface	osid.financials.posting.PostForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidAggregateableForm`
Used By	`osid.financials.posting.PostAdminSession`
Description	This is the form for creating and updating `Posts`. Like all `OsidForms`, 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.
Method	getFiscalPeriodMetadata
Description	Gets the metadata for the fiscal period.
Return	`osid.Metadata`		metadata for the fiscal period
Compliance	`mandatory`		This method must be implemented.
Method	setFiscalPeriod
Description	Sets the fiscal period.
Parameters	`osid.id.Id`	`fiscalPeriodId`	the new fiscal period
Errors	INVALID_ARGUMENT		`fiscalPeriodId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`fiscalPeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFiscalPeriod
Description	Removes the fiscal period.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDateMetadata
Description	Gets the metadata for the date.
Return	`osid.Metadata`		metadata for the date
Compliance	`mandatory`		This method must be implemented.
Method	setDate
Description	Sets the date.
Parameters	`osid.calendaring.DateTime`	`date`	the new 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	clearDate
Description	Removes the date.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCorrectedPostMetadata
Description	Gets the metadata for the corrected post.
Return	`osid.Metadata`		metadata for the corrected post
Compliance	`mandatory`		This method must be implemented.
Method	setCorrectedPost
Description	Sets the corrected post.
Parameters	`osid.id.Id`	`postId`	the new corrected post
Errors	INVALID_ARGUMENT		`postId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`postId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCorrectedPost
Description	Removes the corrected post.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPostFormRecord
Description	Gets the `PostFormRecord` corresponding to the given post record `Type`.
Parameters	`osid.type.Type`	`postRecordType`	a post record type
Return	`osid.financials.posting.records.PostFormRecord`		the post form record
Errors	NULL_ARGUMENT		`postRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(postRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.