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

MethodmatchCreationRule
Description

Matches producers that create todos.

Parametersbooleanmatch true to match creation rules, false to match destruction rules
CompliancemandatoryThis method must be implemented.
MethodclearCreationRuleTerms
Description

Clears the creation rule query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCyclicEventId
Description

Matches producers based on a cyclic event.

Parametersosid.id.IdcyclicEventIdthe cyclic event Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT cyclicEventId is null
CompliancemandatoryThis method must be implemented.
MethodclearCyclicEventIdTerms
Description

Clears the cyclic event Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventQuery
Description

Tests if a CyclicEventQuery is available.

Returnboolean true if a cyclic event query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventQuery
Description

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

Returnosid.calendaring.cycle.CyclicEventQuerythe cyclic event query
ErrorsUNIMPLEMENTED supportsCyclicEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventQuery() is true.
MethodmatchAnyCyclicEvent
Description

Matches producers based on any cyclic event.

Parametersbooleanmatch true for producers based on any cyclic event, false to match producers based on no cyclic event
CompliancemandatoryThis method must be implemented.
MethodclearCyclicEventTerms
Description

Clears the cyclic event query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStockId
Description

Matches producers based on a stock.

Parametersosid.id.IdstockIdthe stock Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT stockId is null
CompliancemandatoryThis method must be implemented.
MethodclearStockIdTerms
Description

Clears the stock Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsStockQuery
Description

Tests if a StockQuery is available.

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

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

Returnosid.inventory.StockQuerythe stock query
ErrorsUNIMPLEMENTED supportsStockQuery() is false
ComplianceoptionalThis method must be implemented if supportsStockQuery() is true.
MethodmatchAnyStock
Description

Matches producers based on any stock.

Parametersbooleanmatch true for producers based on any stock, false to match producers based on no stock
CompliancemandatoryThis method must be implemented.
MethodclearStockTerms
Description

Clears the stock query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStockLevel
Description

Matches producers with a stock level between the given range inclusive.

Parameterscardinalfromstart of range
cardinaltoend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
CompliancemandatoryThis method must be implemented.
MethodmatchAnyStockLevel
Description

Matches producers with any stock level.

Parametersbooleanmatch true for producers with any stock, false to match producers with no stock
CompliancemandatoryThis method must be implemented.
MethodclearStockLevelTerms
Description

Clears the stock level query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProducedTodoId
Description

Matches producers producing to the todo.

Parametersosid.id.IdtodoIdthe todo Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT todoBookId is null
CompliancemandatoryThis method must be implemented.
MethodclearProducedTodoIdTerms
Description

Clears the produced todo Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProducedTodoQuery
Description

Tests if a TodoBookQuery is available.

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

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

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

Matches producers producing to any todo.

Parametersbooleanmatch true for producers producing any todo, false to match producers producing no todo
CompliancemandatoryThis method must be implemented.
MethodclearProducedTodoTerms
Description

Clears the todo query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchChecklistId
Description

Matches producers mapped to the checklist.

Parametersosid.id.IdchecklistIdthe 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 query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsChecklistQuery
Description

Tests if an 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. 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 query terms.

CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerQueryRecord
Description

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

Parametersosid.type.TypetodoProducerRecordTypea todo producer record type
Returnosid.checklist.mason.records.TodoProducerQueryRecordthe todo producer query record
ErrorsNULL_ARGUMENT todoProducerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(todoProducerRecordType) is false
CompliancemandatoryThis method must be implemented.