OSID - osid.billing.EntryForm Service Interface Definition

Interface	osid.billing.EntryForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.billing.batch.EntryBatchForm`
Used By	`osid.billing.EntryAdminSession`
Description	This is the form for creating and updating `Entries` . Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `EntryAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getQuantityMetadata
Description	Gets the metadata for the quantity.
Return	`osid.Metadata`		metadata for the quantity
Compliance	`mandatory`		This method must be implemented.
Method	setQuantity
Description	Sets the quantity.
Parameters	`cardinal`	`quantity`	the new quantity
Errors	INVALID_ARGUMENT		`quantity` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearQuantity
Description	Removes the quantity.
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 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	getEntryFormRecord
Description	Gets the `EntryFormRecord` corresponding to the given entry record `Type` .
Parameters	`osid.type.Type`	`entryRecordType`	an entry record type
Return	`osid.billing.records.EntryFormRecord`		the entry form record
Errors	NULL_ARGUMENT		`entryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(entryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.