OSID - osid.billing.Item Service Interface Definition

Interface	osid.billing.Item
Implements	`osid.OsidObject`
Description	An `Item` is a product or service.
Method	getCategoryId
Description	Gets the category `Id.`
Return	`osid.id.Id`		the category `Id`
Compliance	`mandatory`		This method is must be implemented.
Method	getCategory
Description	Gets the item category.
Return	`osid.billing.Category`		the category
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasAccount
Description	Tests if this item relates to s specific general ledger account.
Return	`boolean`		`true` if this item has an account, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAccountId
Description	Gets the account `Id.`
Return	`osid.id.Id`		the account `Id`
Errors	ILLEGAL_STATE		`hasAccount()` is `false`
Compliance	`mandatory`		This method is must be implemented.
Method	getAccount
Description	Gets the item account.
Return	`osid.financials.Account`		the account
Errors	ILLEGAL_STATE		`hasAccount()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasProduct
Description	Tests if this item relates to s specific product.
Return	`boolean`		`true` if this item has a product, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProductId
Description	Gets the product `Id.`
Return	`osid.id.Id`		the product `Id`
Errors	ILLEGAL_STATE		`hasProduct()` is `false`
Compliance	`mandatory`		This method is must be implemented.
Method	getProduct
Description	Gets the product.
Return	`osid.ordering.Product`		the product
Errors	ILLEGAL_STATE		`hasProduct()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAmount
Description	Gets the amount of this item.
Return	`osid.financials.Currency`		the amount
Compliance	`mandatory`		This method must be implemented.
Method	isDebit
Description	Tests if the amount is a debit or a credit.
Return	`boolean`		`true` if this item amount is a debit, `false` if it is a credit
Compliance	`mandatory`		This method must be implemented.
Method	isRecurring
Description	Tests if this item is a recurring charge.
Return	`boolean`		`true` if this item is recurring, `false` if one-time
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringInterval
Description	Gets the recurring interval.
Return	`osid.calendaring.Duration`		the interval
Errors	ILLEGAL_STATE		`isRecurring()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getItemRecord
Description	Gets the item record corresponding to the given `Item` record `Type.` This method is used to retrieve an object implementing the requested record. The `itemRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(itemRecordType)` is `true` .
Parameters	`osid.type.Type`	`itemRecordType`	the type of item record to retrieve
Return	`osid.billing.records.ItemRecord`		the item record
Errors	NULL_ARGUMENT		`itemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(itemRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.