OSID - osid.billing.ItemSearchOrder Service Interface Definition

Interface	osid.billing.ItemSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByCategory
Description	Specifies a preference for ordering the result set by the category.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategorySearchOrder
Description	Tests if a category search order is available.
Return	`boolean`		`true` if a category search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCategorySearchOrder
Description	Specifies a preference for ordering the result set by the category.
Return	`osid.billing.CategorySearchOrder`		the category search order
Errors	UNIMPLEMENTED		`supportsCategorySearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCategorySearchOrder()` is `true.`
Method	orderByAccount
Description	Specifies a preference for ordering the result set by the account.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountSearchOrder
Description	Tests if an account search order is available.
Return	`boolean`		`true` if an account search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAccountSearchOrder
Description	Specifies a preference for ordering the result set by the account.
Return	`osid.financials.AccountSearchOrder`		the account search order
Errors	UNIMPLEMENTED		`supportsAccountSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAccountSearchOrder()` is `true.`
Method	orderByProduct
Description	Specifies a preference for ordering the result set by the product.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductSearchOrder
Description	Tests if a product search order is available.
Return	`boolean`		`true` if a product search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProductSearchOrder
Description	Specifies a preference for ordering the result set by the product.
Return	`osid.ordering.ProductSearchOrder`		the product search order
Errors	UNIMPLEMENTED		`supportsProductSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProductSearchOrder()` is `true.`
Method	orderByAmount
Description	Specifies a preference for ordering the result set by the amount.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByDebit
Description	Specifies a preference for ordering the result set by debit.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRecurringInterval
Description	Specifies a preference for ordering the result set by interval.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getItemSearchOrderRecord
Description	Gets the item search order record corresponding to the given item record `Type.` Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`itemRecordType`	an item record type
Return	`osid.billing.records.ItemSearchOrderRecord`		the item search order 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.