OSID - osid.checklist.TodoQuery Service Interface Definition

Interface	osid.checklist.TodoQuery
Implements	`osid.OsidObjectQuery`
	`osid.OsidContainableQuery`
	`osid.OsidTemporalQuery`
	`osid.OsidFederateableQuery`
Description	This is the query for searching todos. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchComplete
Description	Matches completed todos.
Parameters	`boolean`	`match`	`true` for to match completed todos, `false` to match incomplete todos
Compliance	`mandatory`		This method must be implemented.
Method	clearCompleteTerms
Description	Clears the complete terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPriority
Description	Matches todos of the given priority.
Parameters	`osid.type.Type`	`priorityType`	a priority type
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`priorityType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPriority
Description	Matches todos with any priority set.
Parameters	`boolean`	`match`	`true` for to match todos with any priority, `false` to match todos with no priority
Compliance	`mandatory`		This method must be implemented.
Method	clearPriorityTerms
Description	Clears the priority terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumPriority
Description	Matches todos of the given priority or greater.
Parameters	`osid.type.Type`	`priorityType`	a priority type
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`priorityType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumPriorityTerms
Description	Clears the minimum priority terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDueDate
Description	Matches todos with dues dates within the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDueDate
Description	Matches todos with any due date.
Parameters	`boolean`	`match`	`true` for to match todos with any due date, `false` to match todos with no due date
Compliance	`mandatory`		This method must be implemented.
Method	clearDueDateTerms
Description	Clears the due date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDependencyId
Description	Matches a depednency todo.
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	clearDependencyIdTerms
Description	Clears the todo `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDependencyQuery
Description	Tests if a `TodoQuery` is available.
Return	`boolean`		`true` if a todo query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDependencyQuery
Description	Gets the query for a todo query. Multiple retrievals produce a nested `OR` term.
Return	`osid.checklist.TodoQuery`		the checklist query
Errors	UNIMPLEMENTED		`supportsDependencyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDependencyQuery()` is `true.`
Method	matchAnyDependency
Description	Matches tdos with any dependencies.
Parameters	`boolean`	`match`	`true` for to matchc todos with any dependency, `false` to matchtodos with no dependencies
Compliance	`mandatory`		This method must be implemented.
Method	clearDependencyTerms
Description	Clears the dependency terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorTodoId
Description	Sets the todo `Id` for this query to match todos that have the specified todo as an ancestor.
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	clearAncestorTodoIdTerms
Description	Clears the ancestor todo `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorTodoQuery
Description	Tests if a `TodoQuery` is available.
Return	`boolean`		`true` if a todo query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorTodoQuery
Description	Gets the query for a todo. Multiple retrievals produce a nested `OR` term.
Return	`osid.checklist.TodoQuery`		the todo query
Errors	UNIMPLEMENTED		`supportsAncestorTodoQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorTodoQuery()` is `true.`
Method	matchAnyAncestorTodo
Description	Matches todos that have any ancestor.
Parameters	`boolean`	`match`	`true` to match todos with any ancestor, `false` to match root todos
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorTodoTerms
Description	Clears the ancestor todo query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantTodoId
Description	Sets the todo `Id` for this query to match todos that have the specified todo as a descendant.
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	clearDescendantTodoIdTerms
Description	Clears the descendant todo `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantTodoQuery
Description	Tests if a `TodoQuery` is available.
Return	`boolean`		`true` if a todo query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantTodoQuery
Description	Gets the query for a todo. Multiple retrievals produce a nested `OR` term.
Return	`osid.checklist.TodoQuery`		the todo query
Errors	UNIMPLEMENTED		`supportsDescendantTodoQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantTodoQuery()` is `true.`
Method	matchAnyDescendantTodo
Description	Matches todos that have any descendant.
Parameters	`boolean`	`match`	`true` to match todos with any descendant, `false` to match leaf todos
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantTodoTerms
Description	Clears the descendant todo query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchChecklistId
Description	Sets the checklist `Id` for this query to match todos assigned to checklists.
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	clearChecklistIdTerms
Description	Clears the checklist `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsChecklistQuery
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	getChecklistQuery
Description	Gets the query for a checklist query. 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 terms.
Compliance	`mandatory`		This method must be implemented.
Method	getTodoQueryRecord
Description	Gets the todo query record corresponding to the given `Todo` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`todoRecordType`	a todo record type
Return	`osid.checklist.records.TodoQueryRecord`		the todo query record
Errors	NULL_ARGUMENT		`todoRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(todoRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.