OSID - osid.checklist.mason.TodoProducerSearchOrder Service Interface Definition

Interface	osid.checklist.mason.TodoProducerSearchOrder
Implements	`osid.OsidRuleSearchOrder`
Used By	`osid.checklist.mason.TodoProducerSearchSession`
Used By	`osid.checklist.mason.TodoProducerSmartChecklistSession`
Description	An interface for specifying the ordering of search results.
Method	orderByCreationRule
Description	Specifies a preference for ordering the result set by the creation rule flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCyclicEvent
Description	Specifies a preference for ordering the result set by the cyclic event.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventSearchOrder
Description	Tests if a cyclic event search order is available.
Return	`boolean`		`true` if a cyclic event search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventSearchOrder
Description	Gets the cyclic event search order.
Return	`osid.calendaring.cycle.CyclicEventSearchOrder`		the cyclic event search order
Errors	UNIMPLEMENTED		`supportsCyclicEventSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventSearchOrder()` is `true` .
Method	orderByStock
Description	Specifies a preference for ordering the result set by the stock.
Parameters	`osid.SearchOrderStyle`	`style`	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 stock search 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	orderByStockLevel
Description	Specifies a preference for ordering the result set by the stock level.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducerSearchOrderRecord
Description	Gets the todo producer search order record corresponding to the given todo producer record `Type` . Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`todoProducerRecordType`	a todo producer record type
Return	`osid.checklist.mason.records.TodoProducerSearchOrderRecord`		the todo producer search order record
Errors	NULL_ARGUMENT		`todoProducerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(todoProducerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.