Interface | osid.checklist.mason.ChecklistMasonManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.checklist.mason.ChecklistMasonProfile | |||
Description |
The checklist mason manager provides access to checklist mason sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getTodoProducerLookupSession | ||
Description |
Gets the | ||
Return | osid.checklist.mason.TodoProducerLookupSession | a TodoProducerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTodoProducerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsTodoProducerLookup()
is true. | |
Method | getTodoProducerLookupSessionForChecklist | ||
Description |
Gets the | ||
Parameters | osid.id.Id | checklistId | the Id of the Checklist |
Return | osid.checklist.mason.TodoProducerLookupSession | a TodoProducerLookupSession | |
Errors | NOT_FOUND | no Checklist found by the given Id | |
NULL_ARGUMENT | checklistId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTodoProducerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTodoProducerLookup()
and supportsVisibleFederation() are true.
| |
Method | getTodoProducerQuerySession | ||
Description |
Gets the | ||
Return | osid.checklist.mason.TodoProducerQuerySession | a TodoProducerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTodoProducerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsTodoProducerQuery()
is true. | |
Method | getTodoProducerQuerySessionForChecklist | ||
Description |
Gets the | ||
Parameters | osid.id.Id | checklistId | the Id of the Checklist |
Return | osid.checklist.mason.TodoProducerQuerySession | a TodoProducerQuerySession | |
Errors | NOT_FOUND | no Checklist found by the given Id | |
NULL_ARGUMENT | checklistId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTodoProducerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTodoProducerQuery()
and supportsVisibleFederation() are true.
| |
Method | getTodoProducerSearchSession | ||
Description |
Gets the | ||
Return | osid.checklist.mason.TodoProducerSearchSession | a TodoProducerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTodoProducerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsTodoProducerSearch()
is true. | |
Method | getTodoProducerSearchSessionForChecklist | ||
Description |
Gets the | ||
Parameters | osid.id.Id | checklistId | the Id of the Checklist |
Return | osid.checklist.mason.TodoProducerSearchSession | a TodoProducerSearchSession | |
Errors | NOT_FOUND | no Checklist found by the given Id | |
NULL_ARGUMENT | checklistId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTodoProducerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTodoProducerSearch()
and supportsVisibleFederation() are true.
| |
Method | getTodoProducerAdminSession | ||
Description |
Gets the | ||
Return | osid.checklist.mason.TodoProducerAdminSession | a TodoProducerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTodoProducerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsTodoProducerAdmin()
is true. | |
Method | getTodoProducerAdminSessionForChecklist | ||
Description |
Gets the | ||
Parameters | osid.id.Id | checklistId | the Id of the Checklist |
Return | osid.checklist.mason.TodoProducerAdminSession | a TodoProducerAdminSession | |
Errors | NOT_FOUND | no Checklist found by the given Id | |
NULL_ARGUMENT | checklistId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTodoProducerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTodoProducerAdmin()
and supportsVisibleFederation() are true.
| |
Method | getTodoProducerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.checklist.mason.TodoProducerReceiver | todoProducerReceiver | the notification callback |
Return | osid.checklist.mason.TodoProducerNotificationSession | a TodoProducerNotificationSession | |
Errors | NULL_ARGUMENT | todoProducerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTodoProducerNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsTodoProducerNotification() is true. | |
Method | getTodoProducerNotificationSessionForChecklist | ||
Description |
Gets the | ||
Parameters | osid.checklist.mason.TodoProducerReceiver | todoProducerReceiver | the notification callback |
osid.id.Id | checklistId | the Id of the Checklist | |
Return | osid.checklist.mason.TodoProducerNotificationSession | a TodoProducerNotificationSession | |
Errors | NOT_FOUND | no checklist found by the given Id | |
NULL_ARGUMENT | todoProducerReceiver or checklistId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTodoProducerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsTodoProducerNotification() and
supportsVisibleFederation() are true. | |
Method | getTodoProducerChecklistSession | ||
Description |
Gets the | ||
Return | osid.checklist.mason.TodoProducerChecklistSession | a TodoProducerChecklistSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTodoProducerChecklist() is false | ||
Compliance | optional | This method must be implemented if supportsTodoProducerChecklist()
is true. | |
Method | getTodoProducerChecklistAssignmentSession | ||
Description |
Gets the | ||
Return | osid.checklist.mason.TodoProducerChecklistAssignmentSession | a TodoProducerChecklistAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTodoProducerChecklistAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsTodoProducerChecklistAssignment() is true. | |
Method | getTodoProducerSmartChecklistSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | checklistId | the Id of the Checklist |
Return | osid.checklist.mason.TodoProducerSmartChecklistSession | a TodoProducerSmartChecklistSession | |
Errors | NOT_FOUND | no Checklist found by the given Id | |
NULL_ARGUMENT | checklistId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTodoProducerSmartChecklist() is false | ||
Compliance | optional | This method must be implemented if
supportsTodoProducerSmartChecklist() is true. |