OSID - osid.billing.EntrySearchOrder Service Interface Definition

Interface	osid.billing.EntrySearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.billing.EntrySearchSession`
Used By	`osid.billing.EntrySmartBusinessSession`
Description	An interface for specifying the ordering of search results.
Method	orderByCustomer
Description	Specifies a preference for ordering the result set by customer.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerSearchOrder
Description	Tests if a customer search order is available.
Return	`boolean`		`true` if a customer search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerSearchOrder
Description	Gets the customer order.
Return	`osid.billing.CustomerSearchOrder`		the customer search order
Errors	UNIMPLEMENTED		`supportsCustomerSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCustomerSearchOrder()` is `true`.
Method	orderByItem
Description	Specifies a preference for ordering the result set by item.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemSearchOrder
Description	Tests if an item search order is available.
Return	`boolean`		`true` if an item search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getItemSearchOrder
Description	Gets the item search order.
Return	`osid.billing.ItemSearchOrder`		the item search order
Errors	UNIMPLEMENTED		`supportsItemSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemSearchOrder()` is `true`.
Method	orderByPeriod
Description	Specifies a preference for ordering the result set by billing period.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodSearchOrder
Description	Tests if a billing period search order is available.
Return	`boolean`		`true` if a term search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodSearchOrder
Description	Gets the billing period search order.
Return	`osid.billing.PeriodSearchOrder`		the period search order
Errors	UNIMPLEMENTED		`supportsPeriodSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPeriodSearchOrder()` is `true`.
Method	orderByQuantity
Description	Specifies a preference for ordering the result set by the quantity.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
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 the debit flag.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEntrySearchOrderRecord
Description	Gets the entry search order record corresponding to the given entry record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`entryRecordType`	an entry record type
Return	`osid.billing.records.EntrySearchOrderRecord`		the entry search order 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.