Interface | osid.checklist.mason.TodoProducerChecklistAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignTodoProducers | ||
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
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignTodoProducersToChecklist | ||
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
| ||
Parameters | osid.id.Id | checklistId | the Id of the Checklist |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | checklistId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableChecklistIds | ||
Description |
Gets a list of checklists including and under the given checklist node in which any todo producer can be assigned. | ||
Parameters | osid.id.Id | checklistId | the Id of the Checklist |
Return | osid.id.IdList | list of assignable checklist Ids | |
Errors | NULL_ARGUMENT | checklistId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableChecklistIdsForTodoProducer | ||
Description |
Gets a list of checklists including and under the given checklist node in which a specific todo producer can be assigned. | ||
Parameters | osid.id.Id | checklistId | the Id of the Checklist |
osid.id.Id | todoProducerId | the Id of the TodoProducer | |
Return | osid.id.IdList | list of assignable checklist Ids | |
Errors | NULL_ARGUMENT | checklistId or todoProducerId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignTodoProducerToChecklist | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | todoProducerId | the Id of the TodoProducer |
osid.id.Id | checklistId | the Id of the Checklist | |
Errors | ALREADY_EXISTS | todoProducerId is already assigned to checklistId
| |
NOT_FOUND | todoProducerId or checklistId not found | ||
NULL_ARGUMENT | todoProducerId or checklistId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignTodoProducerFromChecklist | ||
Description |
Removes a | ||
Parameters | osid.id.Id | todoProducerId | the Id of the TodoProducer |
osid.id.Id | checklistId | the Id of the Checklist | |
Errors | NOT_FOUND | todoProducerId or checklistId not found or
todoProducerId is not assigned to checklistId | |
NULL_ARGUMENT | todoProducerId or checklistId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignTodoProducerToChecklist | ||
Description |
Moves a | ||
Parameters | osid.id.Id | todoProducerId | the Id of the TodoProducer |
osid.id.Id | fromChecklistId | the Id of the current Checklist | |
osid.id.Id | toChecklistId | the Id of the destination Checklist | |
Errors | NOT_FOUND | todoProducerId, fromChecklistId, or toChecklistId
not found or todoProducerId, not mapped to
fromChecklistId | |
NULL_ARGUMENT | todoProducerId,, fromChecklistId, or toChecklistId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |