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

This session provides methods to re-assign TodoProducer to Checklist mappings. A TodoProducer may appear in multiple Checklist objects and removing the last reference to a TodoProducer is the equivalent of deleting it. Each Checklist may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a TodoProducer to another Checklist is not a copy operation (eg: does not change its Id ).

MethodcanAssignTodoProducers
Description

Tests if this user can alter todo producer/checklist mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignTodoProducersToChecklist
Description

Tests if this user can alter todo producer/checklist mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

Parametersosid.id.IdchecklistIdthe Id of the Checklist
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT checklistId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableChecklistIds
Description

Gets a list of checklists including and under the given checklist node in which any todo producer can be assigned.

Parametersosid.id.IdchecklistIdthe Id of the Checklist
Returnosid.id.IdListlist of assignable checklist Ids
ErrorsNULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableChecklistIdsForTodoProducer
Description

Gets a list of checklists including and under the given checklist node in which a specific todo producer can be assigned.

Parametersosid.id.IdchecklistIdthe Id of the Checklist
osid.id.IdtodoProducerIdthe Id of the TodoProducer
Returnosid.id.IdListlist of assignable checklist Ids
ErrorsNULL_ARGUMENT checklistId or todoProducerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignTodoProducerToChecklist
Description

Adds an existing TodoProducer to an Checklist.

Parametersosid.id.IdtodoProducerIdthe Id of the TodoProducer
osid.id.IdchecklistIdthe Id of the Checklist
ErrorsALREADY_EXISTS todoProducerId is already assigned to checklistId
NOT_FOUND todoProducerId or checklistId not found
NULL_ARGUMENT todoProducerId or checklistId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignTodoProducerFromChecklist
Description

Removes a TodoProducer from an Checklist.

Parametersosid.id.IdtodoProducerIdthe Id of the TodoProducer
osid.id.IdchecklistIdthe Id of the Checklist
ErrorsNOT_FOUND todoProducerId or checklistId not found or todoProducerId is not assigned to checklistId
NULL_ARGUMENT todoProducerId or checklistId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignTodoProducerToChecklist
Description

Moves a TodoProducer from one Checklist to another. Mappings to other Checklists are unaffected.

Parametersosid.id.IdtodoProducerIdthe Id of the TodoProducer
osid.id.IdfromChecklistIdthe Id of the current Checklist
osid.id.IdtoChecklistIdthe Id of the destination Checklist
ErrorsNOT_FOUND todoProducerId, fromChecklistId, or toChecklistId not found or todoProducerId, not mapped to fromChecklistId
NULL_ARGUMENT todoProducerId,, fromChecklistId, or toChecklistId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.