OSID - osid.checklist.ChecklistQuery Service Interface Definition

Interface	osid.checklist.ChecklistQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.checklist.ChecklistQuery`
	`osid.checklist.ChecklistQuerySession`
	`osid.checklist.ChecklistSearchSession`
	`osid.checklist.TodoQuery`
	`osid.checklist.mason.TodoProducerQuery`
Description	This is the query for searching for checklists. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchTodoId
Description	Sets the todo `Id` for this query to match todos assigned to checklists.
Parameters	`osid.id.Id`	`todoId`	a todo `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`todoId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTodoIdTerms
Description	Clears the todo `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTodoQuery
Description	Tests if a todo query is available.
Return	`boolean`		`true` if a todo query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTodoQuery
Description	Gets the query for a todo.
Return	`osid.checklist.TodoQuery`		the todo query
Errors	UNIMPLEMENTED		`supportsTodoQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoQuery()` is `true` .
Method	matchAnyTodo
Description	Matches checklists with any todo.
Parameters	`boolean`	`match`	`true` to match checklists with any todo, `false` to match checklists with no todos
Compliance	`mandatory`		This method must be implemented.
Method	clearTodoTerms
Description	Clears the todo terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorChecklistId
Description	Sets the checklist `Id` for this query to match checklists that have the specified checklist as an ancestor.
Parameters	`osid.id.Id`	`checklistId`	a checklist `Id`
Parameters	`boolean`	`match`	`true` for a positive match, a `false` for a negative match
Errors	NULL_ARGUMENT		`checklistId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorChecklistIdTerms
Description	Clears the ancestor checklist `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorChecklistQuery
Description	Tests if a `ChecklistQuery` is available.
Return	`boolean`		`true` if a checklist query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorChecklistQuery
Description	Gets the query for a checklist. Multiple retrievals produce a nested `OR` term.
Return	`osid.checklist.ChecklistQuery`		the checklist query
Errors	UNIMPLEMENTED		`supportsAncestorChecklistQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorChecklistQuery()` is `true` .
Method	matchAnyAncestorChecklist
Description	Matches checklists with any ancestor.
Parameters	`boolean`	`match`	`true` to match checklists with any ancestor, `false` to match root checklists
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorChecklistTerms
Description	Clears the ancestor checklist terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantChecklistId
Description	Sets the checklist `Id` for this query to match checklists that have the specified checklist as a descendant.
Parameters	`osid.id.Id`	`checklistId`	a 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	clearDescendantChecklistIdTerms
Description	Clears the descendant checklist `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantChecklistQuery
Description	Tests if a `ChecklistQuery` is available.
Return	`boolean`		`true` if a checklist query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantChecklistQuery
Description	Gets the query for a checklist. Multiple retrievals produce a nested `OR` term.
Return	`osid.checklist.ChecklistQuery`		the checklist query
Errors	UNIMPLEMENTED		`supportsDescendantChecklistQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantChecklistQuery()` is `true` .
Method	matchAnyDescendantChecklist
Description	Matches checklists with any descendant.
Parameters	`boolean`	`match`	`true` to match checklists with any descendant, `false` to match leaf checklists
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantChecklistTerms
Description	Clears the descendant checklist terms.
Compliance	`mandatory`		This method must be implemented.
Method	getChecklistQueryRecord
Description	Gets the checklist query record corresponding to the given `Checklist` record `Type` . Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`checklistRecordType`	a checklist record type
Return	`osid.checklist.records.ChecklistQueryRecord`		the checklist query record
Errors	NULL_ARGUMENT		`checklistRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(checklistRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.