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

Interface	osid.checklist.mason.TodoProducerQuery
Implements	`osid.OsidRuleQuery`
Used By	`osid.checklist.mason.TodoProducerQuerySession`
	`osid.checklist.mason.TodoProducerSearchSession`
	`osid.checklist.mason.TodoProducerSmartChecklistSession`
Description	This is the query for searching todo producers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchCreationRule
Description	Matches producers that create todos.
Parameters	`boolean`	`match`	`true` to match creation rules, `false` to match destruction rules
Compliance	`mandatory`		This method must be implemented.
Method	clearCreationRuleTerms
Description	Clears the creation rule query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCyclicEventId
Description	Matches producers based on a cyclic event.
Parameters	`osid.id.Id`	`cyclicEventId`	the cyclic event `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`cyclicEventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCyclicEventIdTerms
Description	Clears the cyclic event `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventQuery
Description	Tests if a `CyclicEventQuery` is available.
Return	`boolean`		`true` if a cyclic event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventQuery
Description	Gets the query for a cyclic event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.cycle.CyclicEventQuery`		the cyclic event query
Errors	UNIMPLEMENTED		`supportsCyclicEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventQuery()` is `true` .
Method	matchAnyCyclicEvent
Description	Matches producers based on any cyclic event.
Parameters	`boolean`	`match`	`true` for producers based on any cyclic event, `false` to match producers based on no cyclic event
Compliance	`mandatory`		This method must be implemented.
Method	clearCyclicEventTerms
Description	Clears the cyclic event query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStockId
Description	Matches producers based on a stock.
Parameters	`osid.id.Id`	`stockId`	the stock `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`stockId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStockIdTerms
Description	Clears the stock `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockQuery
Description	Tests if a `StockQuery` is available.
Return	`boolean`		`true` if a stock query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStockQuery
Description	Gets the query for a stock. Multiple retrievals produce a nested `OR` term.
Return	`osid.inventory.StockQuery`		the stock query
Errors	UNIMPLEMENTED		`supportsStockQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockQuery()` is `true` .
Method	matchAnyStock
Description	Matches producers based on any stock.
Parameters	`boolean`	`match`	`true` for producers based on any stock, `false` to match producers based on no stock
Compliance	`mandatory`		This method must be implemented.
Method	clearStockTerms
Description	Clears the stock query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStockLevel
Description	Matches producers with a stock level between the given range inclusive.
Parameters	`cardinal`	`from`	start of range
	`cardinal`	`to`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyStockLevel
Description	Matches producers with any stock level.
Parameters	`boolean`	`match`	`true` for producers with any stock, `false` to match producers with no stock
Compliance	`mandatory`		This method must be implemented.
Method	clearStockLevelTerms
Description	Clears the stock level query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProducedTodoId
Description	Matches producers producing to the todo.
Parameters	`osid.id.Id`	`todoId`	the todo `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`todoBookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProducedTodoIdTerms
Description	Clears the produced todo `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProducedTodoQuery
Description	Tests if a `TodoBookQuery` is available.
Return	`boolean`		`true` if a todo query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProducedTodoQuery
Description	Gets the query for a todo. Multiple retrievals produce a nested `OR` term.
Return	`osid.checklist.TodoQuery`		the todo query
Errors	UNIMPLEMENTED		`supportsProducedTodoQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProducedTodoQuery()` is `true` .
Method	matchAnyProducedTodo
Description	Matches producers producing to any todo.
Parameters	`boolean`	`match`	`true` for producers producing any todo, `false` to match producers producing no todo
Compliance	`mandatory`		This method must be implemented.
Method	clearProducedTodoTerms
Description	Clears the todo query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchChecklistId
Description	Matches producers mapped to the checklist.
Parameters	`osid.id.Id`	`checklistId`	the checklist `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`checklistId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearChecklistIdTerms
Description	Clears the checklist `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsChecklistQuery
Description	Tests if an `ChecklistQuery` is available.
Return	`boolean`		`true` if a checklist query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getChecklistQuery
Description	Gets the query for a checklist. Multiple retrievals produce a nested `OR` term.
Return	`osid.checklist.ChecklistQuery`		the checklist query
Errors	UNIMPLEMENTED		`supportsChecklistQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChecklistQuery()` is `true` .
Method	clearChecklistTerms
Description	Clears the checklist query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducerQueryRecord
Description	Gets the todo producer query record corresponding to the given `TodoProducer` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`todoProducerRecordType`	a todo producer record type
Return	`osid.checklist.mason.records.TodoProducerQueryRecord`		the todo producer query 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.