OSID - osid.inventory.InventorySearchOrder Service Interface Definition

Interface	osid.inventory.InventorySearchOrder
Implements	`osid.OsidObjectSearchOrder`
Implements	`osid.OsidSubjugateableSearchOrder`
Used By	`osid.inventory.InventorySearchSession`
Used By	`osid.inventory.InventorySmartWarehouseSession`
Description	An interface for specifying the ordering of search results.
Method	orderByStock
Description	Specifies a preference for ordering the result set by the stock.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockSearchOrder
Description	Tests if a `StockSearchOrder` is available.
Return	`boolean`		`true` if a stock search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStockSearchOrder
Description	Gets the search order for a stock.
Return	`osid.inventory.StockSearchOrder`		the stock search order
Errors	UNIMPLEMENTED		`supportsStockSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockSearchOrder()` is `true`.
Method	orderByDate
Description	Specifies a preference for ordering the result set by the date.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
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	getInventorySearchOrderRecord
Description	Gets the inventory search order record corresponding to the given inventory record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`inventoryRecordType`	an inventory record type
Return	`osid.inventory.records.InventorySearchOrderRecord`		the inventory search order record
Errors	NULL_ARGUMENT		`inventoryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(inventoryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.