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

MethodmatchTodoId
Description

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

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.
MethodclearTodoIdTerms
Description

Clears the todo Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsTodoQuery
Description

Tests if a todo query is available.

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

Gets the query for a todo.

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

Matches checklists with any todo.

Parametersbooleanmatch true to match checklists with any todo, false to match checklists with no todos
CompliancemandatoryThis method must be implemented.
MethodclearTodoTerms
Description

Clears the todo terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorChecklistId
Description

Sets the checklist Id for this query to match checklists that have the specified checklist as an ancestor.

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

Clears the ancestor checklist Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorChecklistQuery
Description

Tests if a ChecklistQuery is available.

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

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

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

Matches checklists with any ancestor.

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

Clears the ancestor checklist terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantChecklistId
Description

Sets the checklist Id for this query to match checklists that have the specified checklist as a descendant.

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.
MethodclearDescendantChecklistIdTerms
Description

Clears the descendant checklist Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantChecklistQuery
Description

Tests if a ChecklistQuery is available.

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

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

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

Matches checklists with any descendant.

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

Clears the descendant checklist terms.

CompliancemandatoryThis method must be implemented.
MethodgetChecklistQueryRecord
Description

Gets the checklist query record corresponding to the given Checklist record Type. Multiple record retrievals produce a nested boolean OR term.

Parametersosid.type.TypechecklistRecordTypea checklist record type
Returnosid.checklist.records.ChecklistQueryRecordthe checklist query record
ErrorsNULL_ARGUMENT checklistRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(checklistRecordType) is false
CompliancemandatoryThis method must be implemented.