OSID - osid.inventory.shipment.EntrySearchOrder Service Interface Definition

Interface	osid.inventory.shipment.EntrySearchOrder
Implements	`osid.OsidObjectSearchOrder`
Implements	`osid.OsidSubjugateableSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByStock
Description	Specifies a preference for ordering the result set by 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 stock search order 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 shipment order.
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	orderByModel
Description	Specifies a preference for ordering the result set by the model.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelSearchOrder
Description	Tests if a model search order is available.
Return	`boolean`		`true` if a model search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getModelSearchOrder
Description	Gets the model search order.
Return	`osid.inventory.ModelSearchOrder`		the item search order
Errors	UNIMPLEMENTED		`supportsModelSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelSearchOrder()` is `true`.
Method	orderByItem
Description	Specifies a preference for ordering the result set by the 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.inventory.ItemSearchOrder`		the item search order
Errors	UNIMPLEMENTED		`supportsItemSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemSearchOrder()` is `true`.
Method	orderByQuantity
Description	Specifies a preference for ordering the result set by quantity.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByUnitType
Description	Specifies a preference for ordering the result set by the unit type.
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.inventory.shipment.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.