OSID - osid.financials.AccountForm Service Interface Definition

Interface	osid.financials.AccountForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidFederateableForm`
Implemented By	`osid.financials.batch.AccountBatchForm`
Used By	`osid.financials.AccountAdminSession`
Description	This is the form for creating and updating `Accounts`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `AccountAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getCreditBalanceMetadata
Description	Gets the metadata for the credit balance.
Return	`osid.Metadata`		metadata for the credit balance
Compliance	`mandatory`		This method must be implemented.
Method	setCreditBalance
Description	Sets the credit balance flag.
Parameters	`boolean`	`credit`	`true` if credits increase the balance, `false` if credits decrease the balance
Errors	INVALID_ARGUMENT		`credit` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditBalance
Description	Removes the credit balance flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCodeMetadata
Description	Gets the metadata for the code.
Return	`osid.Metadata`		metadata for the code
Compliance	`mandatory`		This method must be implemented.
Method	setCode
Description	Sets the code.
Parameters	`string`	`code`	the new code
Errors	INVALID_ARGUMENT		`code` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`code` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCode
Description	Removes the code.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAccountFormRecord
Description	Gets the `AccountFormRecord` corresponding to the given account record `Type`.
Parameters	`osid.type.Type`	`accountRecordType`	an account record type
Return	`osid.financials.records.AccountFormRecord`		the account form record
Errors	NULL_ARGUMENT		`accountRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(accountRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.