OSID Logo
OSID Specifications
checklist mason package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.mason.ChecklistMasonManager
Implementsosid.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:

  • TodoProducerLookupSession: a session to retrieve todo producers
  • TodoProducerQuerySession: a session to query for todo producers
  • TodoProducerSearchSession: a session to search for todo producers
  • TodoProducerAdminSession: a session to create and delete todo producers
  • TodoProducerNotificationSession: a session to receive notifications pertaining to todo producer changes
  • TodoProducerChecklistSession: a session to look up todo producer checklist mappings
  • TodoProducerChecklistAssignmentSession: a session to manage todo producer to checklist mappings
  • TodoProducerSmartChecklistSession: a session to manage dynamic checklists of todo producers
MethodgetTodoProducerLookupSession
Description

Gets the OsidSession associated with the todo producer lookup service.

Returnosid.checklist.mason.TodoProducerLookupSessiona TodoProducerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerLookup() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerLookup() is true.
MethodgetTodoProducerLookupSessionForChecklist
Description

Gets the OsidSession associated with the todo producer lookup service for the given checklist.

Parametersosid.id.IdchecklistIdthe Id of the Checklist
Returnosid.checklist.mason.TodoProducerLookupSessiona TodoProducerLookupSession
ErrorsNOT_FOUNDno Checklist found by the given Id
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerLookup() and supportsVisibleFederation() are true.
MethodgetTodoProducerQuerySession
Description

Gets the OsidSession associated with the todo producer query service.

Returnosid.checklist.mason.TodoProducerQuerySessiona TodoProducerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerQuery() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerQuery() is true.
MethodgetTodoProducerQuerySessionForChecklist
Description

Gets the OsidSession associated with the todo producer query service for the given checklist.

Parametersosid.id.IdchecklistIdthe Id of the Checklist
Returnosid.checklist.mason.TodoProducerQuerySessiona TodoProducerQuerySession
ErrorsNOT_FOUNDno Checklist found by the given Id
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerQuery() and supportsVisibleFederation() are true.
MethodgetTodoProducerSearchSession
Description

Gets the OsidSession associated with the todo producer search service.

Returnosid.checklist.mason.TodoProducerSearchSessiona TodoProducerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerSearch() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerSearch() is true.
MethodgetTodoProducerSearchSessionForChecklist
Description

Gets the OsidSession associated with the todo producers earch service for the given checklist.

Parametersosid.id.IdchecklistIdthe Id of the Checklist
Returnosid.checklist.mason.TodoProducerSearchSessiona TodoProducerSearchSession
ErrorsNOT_FOUNDno Checklist found by the given Id
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerSearch() and supportsVisibleFederation() are true.
MethodgetTodoProducerAdminSession
Description

Gets the OsidSession associated with the todo producer administration service.

Returnosid.checklist.mason.TodoProducerAdminSessiona TodoProducerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerAdmin() is true.
MethodgetTodoProducerAdminSessionForChecklist
Description

Gets the OsidSession associated with the todo producer administration service for the given checklist.

Parametersosid.id.IdchecklistIdthe Id of the Checklist
Returnosid.checklist.mason.TodoProducerAdminSessiona TodoProducerAdminSession
ErrorsNOT_FOUNDno Checklist found by the given Id
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerAdmin() and supportsVisibleFederation() are true.
MethodgetTodoProducerNotificationSession
Description

Gets the OsidSession associated with the todo producer notification service.

Parametersosid.checklist.mason.TodoProducerReceivertodoProducerReceiverthe notification callback
Returnosid.checklist.mason.TodoProducerNotificationSessiona TodoProducerNotificationSession
ErrorsNULL_ARGUMENT todoProducerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerNotification() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerNotification() is true.
MethodgetTodoProducerNotificationSessionForChecklist
Description

Gets the OsidSession associated with the todo producer notification service for the given checklist.

Parametersosid.checklist.mason.TodoProducerReceivertodoProducerReceiverthe notification callback
osid.id.IdchecklistIdthe Id of the Checklist
Returnosid.checklist.mason.TodoProducerNotificationSessiona TodoProducerNotificationSession
ErrorsNOT_FOUNDno checklist found by the given Id
NULL_ARGUMENT todoProducerReceiver or checklistId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerNotification() and supportsVisibleFederation() are true.
MethodgetTodoProducerChecklistSession
Description

Gets the OsidSession to lookup todo producer/checklist mappings for todo producers.

Returnosid.checklist.mason.TodoProducerChecklistSessiona TodoProducerChecklistSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerChecklist() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerChecklist() is true.
MethodgetTodoProducerChecklistAssignmentSession
Description

Gets the OsidSession associated with assigning todo producers to checklists for todo.

Returnosid.checklist.mason.TodoProducerChecklistAssignmentSessiona TodoProducerChecklistAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerChecklistAssignment() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerChecklistAssignment() is true.
MethodgetTodoProducerSmartChecklistSession
Description

Gets the OsidSession to manage todo producer smart checklists.

Parametersosid.id.IdchecklistIdthe Id of the Checklist
Returnosid.checklist.mason.TodoProducerSmartChecklistSessiona TodoProducerSmartChecklistSession
ErrorsNOT_FOUNDno Checklist found by the given Id
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoProducerSmartChecklist() is false
ComplianceoptionalThis method must be implemented if supportsTodoProducerSmartChecklist() is true.