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

Interface	osid.financials.posting.PostEntryForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidSubjugateableForm`
Used By	`osid.financials.posting.PostEntryAdminSession`
Description	This is the form for creating and updating `PostEntries`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `PostEntryAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getAccountMetadata
Description	Gets the metadata for the account.
Return	`osid.Metadata`		metadata for the account
Compliance	`mandatory`		This method must be implemented.
Method	setAccount
Description	Sets the account.
Parameters	`osid.id.Id`	`accountId`	the new account
Errors	INVALID_ARGUMENT		`accountId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`accountId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAccount
Description	Removes the account.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityMetadata
Description	Gets the metadata for the activity.
Return	`osid.Metadata`		metadata for the activity
Compliance	`mandatory`		This method must be implemented.
Method	setActivity
Description	Sets the activity.
Parameters	`osid.id.Id`	`activityId`	the new activity
Errors	INVALID_ARGUMENT		`activityId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`activityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActivity
Description	Removes the activity.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAmountMetadata
Description	Gets the metadata for the amount.
Return	`osid.Metadata`		metadata for the amount
Compliance	`mandatory`		This method must be implemented.
Method	setAmount
Description	Sets the amount.
Parameters	`osid.financials.Currency`	`amount`	the new amount
Errors	INVALID_ARGUMENT		`amount` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`amount` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAmount
Description	Removes the amount.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDebitMetadata
Description	Gets the metadata for the debit flag.
Return	`osid.Metadata`		metadata for the debit flag
Compliance	`mandatory`		This method must be implemented.
Method	setDebit
Description	Sets the debit flag.
Parameters	`boolean`	`debit`	`true` if this post entry is a debit, `false` if a credit
Errors	INVALID_ARGUMENT		`debit` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearDebit
Description	Clears the debit flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntryFormRecord
Description	Gets the `PostEntryFormRecord` corresponding to the given post entry record `Type`.
Parameters	`osid.type.Type`	`postEntryRecordType`	a post entry record type
Return	`osid.financials.posting.records.PostEntryFormRecord`		the post entry form record
Errors	NULL_ARGUMENT		`postEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(postEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.