OSID Logo
OSID Specifications
checklist mason package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.mason.TodoProducerSmartChecklistSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic checklists. A TodoProducerQuery can be retrieved from this session and mapped to this Checklist to create a virtual collection of todo producers. The todo producers may be sequenced using the TodoProducerSearchOrder from this session.

This Checklist has a default query that matches any todo producer and a default search order that specifies no sequencing. The queries may be examined using a TodoProducerQueryInspector. The query may be modified by converting the inspector back to a TodoProducerQuery.

MethodgetChecklistId
Description

Gets the Checklist Id associated with this session.

Returnosid.id.Idthe Checklist Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetChecklist
Description

Gets the Checklist associated with this session.

Returnosid.checklist.Checklistthe checklist
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartChecklists
Description

Tests if this user can manage smart checklists. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returnboolean false if smart checklist management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerQuery
Description

Gets a todo producer query.

Returnosid.checklist.mason.TodoProducerQuerythe todo producer query
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerSearchOrder
Description

Gets a todo producer search order.

Returnosid.checklist.mason.TodoProducerSearchOrderthe todo producer search order
CompliancemandatoryThis method must be implemented.
MethodapplyTodoProducerQuery
Description

Applies a todo producer query to this checklist.

Parametersosid.checklist.mason.TodoProducerQuerytodoProducerQuerythe todo producer query
ErrorsNULL_ARGUMENT todoProducerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED todoProducerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectTodoProducerQuery
Description

Gets a todo producer query inspector for this checklist.

Returnosid.checklist.mason.TodoProducerQueryInspectorthe todo producer query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyTodoProducerSequencing
Description

Applies a todo producer search order to this checklist.

Parametersosid.checklist.mason.TodoProducerSearchOrdertodoProducerSearchOrderthe todo producer search order
ErrorsNULL_ARGUMENT todoProducerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED todoProducerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerQueryFromInspector
Description

Gets a todo producer query from an inspector.

Parametersosid.checklist.mason.TodoProducerQueryInspectortodoProducerQueryInspectora todo producer query inspector
Returnosid.checklist.mason.TodoProducerQuerythe todo producer query
ErrorsNULL_ARGUMENT todoProducerQueryInspector is null
UNSUPPORTED todoProducerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.