OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.TodoQuery
Implementsosid.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.

MethodmatchComplete
Description

Matches completed todos.

Parametersbooleanmatch true for to match completed todos, false to match incomplete todos
CompliancemandatoryThis method must be implemented.
MethodclearCompleteTerms
Description

Clears the complete terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPriority
Description

Matches todos of the given priority.

Parametersosid.type.TypepriorityTypea priority type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT priorityType is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyPriority
Description

Matches todos with any priority set.

Parametersbooleanmatch true for to match todos with any priority, false to match todos with no priority
CompliancemandatoryThis method must be implemented.
MethodclearPriorityTerms
Description

Clears the priority terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumPriority
Description

Matches todos of the given priority or greater.

Parametersosid.type.TypepriorityTypea priority type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT priorityType is null
CompliancemandatoryThis method must be implemented.
MethodclearMinimumPriorityTerms
Description

Clears the minimum priority terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDueDate
Description

Matches todos with dues dates within the given date range inclusive.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyDueDate
Description

Matches todos with any due date.

Parametersbooleanmatch true for to match todos with any due date, false to match todos with no due date
CompliancemandatoryThis method must be implemented.
MethodclearDueDateTerms
Description

Clears the due date terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDependencyId
Description

Matches a depednency todo.

Parametersosid.id.IdtodoIda todo Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT todoId is null
CompliancemandatoryThis method must be implemented.
MethodclearDependencyIdTerms
Description

Clears the todo Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDependencyQuery
Description

Tests if a TodoQuery is available.

Returnboolean true if a todo query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDependencyQuery
Description

Gets the query for a todo query. Multiple retrievals produce a nested OR term.

Returnosid.checklist.TodoQuerythe checklist query
ErrorsUNIMPLEMENTED supportsDependencyQuery() is false
ComplianceoptionalThis method must be implemented if supportsDependencyQuery() is true.
MethodmatchAnyDependency
Description

Matches tdos with any dependencies.

Parametersbooleanmatch true for to matchc todos with any dependency, false to matchtodos with no dependencies
CompliancemandatoryThis method must be implemented.
MethodclearDependencyTerms
Description

Clears the dependency terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorTodoId
Description

Sets the todo Id for this query to match todos that have the specified todo as an ancestor.

Parametersosid.id.IdtodoIda todo Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT todoId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorTodoIdTerms
Description

Clears the ancestor todo Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorTodoQuery
Description

Tests if a TodoQuery is available.

Returnboolean true if a todo query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorTodoQuery
Description

Gets the query for a todo. Multiple retrievals produce a nested OR term.

Returnosid.checklist.TodoQuerythe todo query
ErrorsUNIMPLEMENTED supportsAncestorTodoQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorTodoQuery() is true.
MethodmatchAnyAncestorTodo
Description

Matches todos that have any ancestor.

Parametersbooleanmatch true to match todos with any ancestor, false to match root todos
CompliancemandatoryThis method must be implemented.
MethodclearAncestorTodoTerms
Description

Clears the ancestor todo query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantTodoId
Description

Sets the todo Id for this query to match todos that have the specified todo as a descendant.

Parametersosid.id.IdtodoIda todo Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT todoId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantTodoIdTerms
Description

Clears the descendant todo Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantTodoQuery
Description

Tests if a TodoQuery is available.

Returnboolean true if a todo query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantTodoQuery
Description

Gets the query for a todo. Multiple retrievals produce a nested OR term.

Returnosid.checklist.TodoQuerythe todo query
ErrorsUNIMPLEMENTED supportsDescendantTodoQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantTodoQuery() is true.
MethodmatchAnyDescendantTodo
Description

Matches todos that have any descendant.

Parametersbooleanmatch true to match todos with any descendant, false to match leaf todos
CompliancemandatoryThis method must be implemented.
MethodclearDescendantTodoTerms
Description

Clears the descendant todo query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchChecklistId
Description

Sets the checklist Id for this query to match todos assigned to checklists.

Parametersosid.id.IdchecklistIda checklist Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT checklistId is null
CompliancemandatoryThis method must be implemented.
MethodclearChecklistIdTerms
Description

Clears the checklist Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsChecklistQuery
Description

Tests if a ChecklistQuery is available.

Returnboolean true if a checklist query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetChecklistQuery
Description

Gets the query for a checklist query. Multiple retrievals produce a nested OR term.

Returnosid.checklist.ChecklistQuerythe checklist query
ErrorsUNIMPLEMENTED supportsChecklistQuery() is false
ComplianceoptionalThis method must be implemented if supportsChecklistQuery() is true.
MethodclearChecklistTerms
Description

Clears the checklist terms.

CompliancemandatoryThis method must be implemented.
MethodgetTodoQueryRecord
Description

Gets the todo query record corresponding to the given Todo record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypetodoRecordTypea todo record type
Returnosid.checklist.records.TodoQueryRecordthe todo query record
ErrorsNULL_ARGUMENT todoRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(todoRecordType) is false
CompliancemandatoryThis method must be implemented.