OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.ChecklistManager
Implementsosid.OsidManager
osid.checklist.ChecklistProfile
Description

The checklist manager provides access to checklist sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • TodoLookupSession: a session to lookup todos
  • TodoQuerySession: a session to query todos
  • TodoSearchSession: a session to search todos
  • TodoAdminSession: a session to manage todos
  • TodoNotificationSession: a session to subscribe to notifications of todo changes
  • TodoHierarchySession: a session to traverse a hierarchy of todos
  • TodoHierarchyDesignSession: a session to manage a todo hierarchy
  • TodoChecklistSession: a session for looking up todo and checklist mappings
  • TodoChecklistAssignmentSession: a session for managing todo and checklist mappings
  • TodoSmartChecklistSession: a session to manage dynamic todo checklists
  • ChecklistLookupSession: a session to retrieve checklists
  • ChecklistQuerySession: a session to query checklists
  • ChecklistSearchSession: a session to search for checklists
  • ChecklistAdminSession: a session to create, update and delete checklists
  • ChecklistNotificationSession: a session to receive notifications for changes in checklists
  • ChecklistHierarchyTraversalSession: a session to traverse hierarchies of checklists
  • ChecklistHierarchyDesignSession: a session to manage hierarchies of checklists

The todoing manager also provides a profile for determing the supported search types supported by this service.

MethodgetTodoLookupSession
Description

Gets the OsidSession associated with the todo lookup service.

Returnosid.checklist.TodoLookupSessiona TodoLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoLookup() is false
ComplianceoptionalThis method must be implemented if supportsTodoLookup() is true.
MethodgetTodoLookupSessionForChecklist
Description

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

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

Gets the OsidSession associated with the todo query service.

Returnosid.checklist.TodoQuerySessiona TodoQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoQuery() is false
ComplianceoptionalThis method must be implemented if supportsTodoQuery() is true.
MethodgetTodoQuerySessionForChecklist
Description

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

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

Gets the OsidSession associated with the todo search service.

Returnosid.checklist.TodoSearchSessiona TodoSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoSearch() is false
ComplianceoptionalThis method must be implemented if supportsTodoSearch() is true.
MethodgetTodoSearchSessionForChecklist
Description

Gets the OsidSession associated with the todo search service for the given checklist.

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

Gets the OsidSession associated with the todo administration service.

Returnosid.checklist.TodoAdminSessiona TodoAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoAdmin() is false
ComplianceoptionalThis method must be implemented if supportsTodoAdmin() is true.
MethodgetTodoAdminSessionForChecklist
Description

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

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

Gets the OsidSession associated with the todo notification service.

Parametersosid.checklist.TodoReceivertodoReceiverthe receiver
Returnosid.checklist.TodoNotificationSessiona TodoNotificationSession
ErrorsNULL_ARGUMENT todoReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoNotification() is false
ComplianceoptionalThis method must be implemented if supportsTodoNotification() is true.
MethodgetTodoNotificationSessionForChecklist
Description

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

Parametersosid.checklist.TodoReceivertodoReceiverthe receiver
osid.id.IdchecklistIdthe Id of the Checklist
Returnosid.checklist.TodoNotificationSessiona TodoNotificationSession
ErrorsNOT_FOUNDno Checklist found by the given Id
NULL_ARGUMENT todoReceiver or checklistId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTodoNotification() and supportsVisibleFederation() are true
MethodgetTodoHierarchySession
Description

Gets the todo hierarchy traversal session.

Returnosid.checklist.TodoHierarchySession a TodoHierarchySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsTodoHierarchy() is true.
MethodgetTodoHierarchySessionForChecklist
Description

Gets the todo hierarchy traversal session for the given checklist.

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

Gets the todo hierarchy design session.

Returnosid.checklist.TodoHierarchyDesignSessiona TodoHierarchyDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsTodoHierarchyDesign() is true.
MethodgetTodoHierarchyDesignSessionForChecklist
Description

Gets the todo hierarchy design session for the given checklist.

Parametersosid.id.IdbusinessIdthe Id of the Checklist
Returnosid.checklist.TodoHierarchyDesignSessiona TodoHierarchyDesignSession
ErrorsNOT_FOUNDno checklist found by the given Id
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoHierarchyDesign() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTodoHierarchyDesign() and supportsVisibleFederation() are true
MethodgetTodoChecklistSession
Description

Gets the session for retrieving todo to checklist mappings.

Returnosid.checklist.TodoChecklistSessiona TodoChecklistSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoChecklist() is false
ComplianceoptionalThis method must be implemented if supportsTodoChecklist() is true.
MethodgetTodoChecklistAssignmentSession
Description

Gets the session for assigning todo to checklist mappings.

Returnosid.checklist.TodoChecklistAssignmentSessiona TodoChecklistAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoChecklistAssignment() is false
ComplianceoptionalThis method must be implemented if supportsTodoChecklistAssignment() is true.
MethodgetTodoSmartChecklistSession
Description

Gets the session associated with the todo smart checklist for the given checklist.

Parametersosid.id.IdchecklistIdthe Id of the checklist
Returnosid.checklist.TodoSmartChecklistSessiona TodoSmartChecklistSession
ErrorsNOT_FOUND checklistId not found
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoSmartChecklist() is false
ComplianceoptionalThis method must be implemented if supportsTodoSmartChecklist() is true.
MethodgetChecklistLookupSession
Description

Gets the OsidSession associated with the checklist lookup service.

Returnosid.checklist.ChecklistLookupSessiona ChecklistLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistLookup() is false
ComplianceoptionalThis method must be implemented if supportsChecklistLookup() is true.
MethodgetChecklistQuerySession
Description

Gets the OsidSession associated with the checklist query service.

Returnosid.checklist.ChecklistQuerySessiona ChecklistQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistQuery() is false
ComplianceoptionalThis method must be implemented if supportsChecklistQuery() is true.
MethodgetChecklistSearchSession
Description

Gets the OsidSession associated with the checklist search service.

Returnosid.checklist.ChecklistSearchSessiona ChecklistSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistSearch() is false
ComplianceoptionalThis method must be implemented if supportsChecklistSearch() is true.
MethodgetChecklistAdminSession
Description

Gets the OsidSession associated with the checklist administrative service.

Returnosid.checklist.ChecklistAdminSessiona ChecklistAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistAdmin() is false
ComplianceoptionalThis method must be implemented if supportsChecklistAdmin() is true.
MethodgetChecklistNotificationSession
Description

Gets the OsidSession associated with the checklist notification service.

Parametersosid.checklist.ChecklistReceiverchecklistReceiverthe receiver
Returnosid.checklist.ChecklistNotificationSessiona ChecklistNotificationSession
ErrorsNULL_ARGUMENT checklistReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistNotification() is false
ComplianceoptionalThis method must be implemented if supportsChecklistNotification() is true.
MethodgetChecklistHierarchySession
Description

Gets the OsidSession associated with the checklist hierarchy service.

Returnosid.checklist.ChecklistHierarchySessiona ChecklistHierarchySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsChecklistHierarchy() is true.
MethodgetChecklistHierarchyDesignSession
Description

Gets the OsidSession associated with the checklist hierarchy design service.

Returnosid.checklist.ChecklistHierarchyDesignSessiona ChecklistHierarchyDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsChecklistHierarchyDesign() is true.
MethodgetChecklistBatchManager
Description

Gets a ChecklistBatchManager.

Returnosid.checklist.batch.ChecklistBatchManagera ChecklistBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistBatch() is false
ComplianceoptionalThis method must be implemented if supportsChecklistBatch() is true.
MethodgetChecklistMasonManager
Description

Gets a ChecklistMasonManager.

Returnosid.checklist.mason.ChecklistMasonManagera ChecklistMasonManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistMason() is false
ComplianceoptionalThis method must be implemented if supportsChecklistMason() is true.