Interface | osid.checklist.mason.TodoProducerChecklistSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupTodoProducerChecklistMappings | ||
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 | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeTodoProducerChecklistView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryTodoProducerChecklistView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getTodoProducerIdsByChecklist | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | checklistId | Id of the Checklist |
Return | osid.id.IdList | list of related todo producer Ids | |
Errors | NOT_FOUND | checklistId is not found | |
NULL_ARGUMENT | checklistId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTodoProducersByChecklist | ||
Description |
Gets the list of todo producers associated with an
| ||
Parameters | osid.id.Id | checklistId | Id of the Checklist |
Return | osid.checklist.mason.TodoProducerList | list of related todo producers | |
Errors | NOT_FOUND | checklistId is not found | |
NULL_ARGUMENT | checklistId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTodoProducerIdsByChecklists | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | checklistIds | list of checklist Ids |
Return | osid.id.IdList | list of todo producer Ids | |
Errors | NULL_ARGUMENT | checklistIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTodoProducersByChecklists | ||
Description |
Gets the list of todo producers corresponding to a list
of | ||
Parameters | osid.id.IdList | checklistIds | list of checklist Ids |
Return | osid.checklist.mason.TodoProducerList | list of todo producers | |
Errors | NULL_ARGUMENT | checklistIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChecklistIdsByTodoProducer | ||
Description |
Gets the | ||
Parameters | osid.id.Id | todoProducerId | Id of a TodoProducer |
Return | osid.id.IdList | list of checklists | |
Errors | NOT_FOUND | todoProducerId is not found | |
NULL_ARGUMENT | todoProducerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChecklistsByTodoProducer | ||
Description |
Gets the | ||
Parameters | osid.id.Id | todoProducerId | Id of a TodoProducer |
Return | osid.checklist.ChecklistList | list of checklists | |
Errors | NOT_FOUND | todoProducerId is not found | |
NULL_ARGUMENT | todoProducerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |