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

This session provides methods to retrieve TodoProducer to Checklist mappings. A TodoProducer may appear in multiple Checklist objects. Each checklist may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupTodoProducerChecklistMappings
Description

Tests if this user can perform lookups of todo producer/checklist mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeTodoProducerChecklistView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryTodoProducerChecklistView
Description

A complete view of the TodoProducer and Checklist returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetTodoProducerIdsByChecklist
Description

Gets the list of TodoProducerIds associated with an Checklist.

Parametersosid.id.IdchecklistId Id of the Checklist
Returnosid.id.IdListlist of related todo producer Ids
ErrorsNOT_FOUND checklistId is not found
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducersByChecklist
Description

Gets the list of todo producers associated with an Checklist.

Parametersosid.id.IdchecklistId Id of the Checklist
Returnosid.checklist.mason.TodoProducerListlist of related todo producers
ErrorsNOT_FOUND checklistId is not found
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerIdsByChecklists
Description

Gets the list of TodoProducer Ids corresponding to a list of Checklists.

Parametersosid.id.IdListchecklistIdslist of checklist Ids
Returnosid.id.IdListlist of todo producer Ids
ErrorsNULL_ARGUMENT checklistIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducersByChecklists
Description

Gets the list of todo producers corresponding to a list of Checklists.

Parametersosid.id.IdListchecklistIdslist of checklist Ids
Returnosid.checklist.mason.TodoProducerListlist of todo producers
ErrorsNULL_ARGUMENT checklistIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChecklistIdsByTodoProducer
Description

Gets the Checklist Ids mapped to a TodoProducer.

Parametersosid.id.IdtodoProducerId Id of a TodoProducer
Returnosid.id.IdListlist of checklists
ErrorsNOT_FOUND todoProducerId is not found
NULL_ARGUMENT todoProducerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChecklistsByTodoProducer
Description

Gets the Checklists mapped to a TodoProducer.

Parametersosid.id.IdtodoProducerId Id of a TodoProducer
Returnosid.checklist.ChecklistListlist of checklists
ErrorsNOT_FOUND todoProducerId is not found
NULL_ARGUMENT todoProducerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.