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

The checklist manager provides access to checklist sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoLookupSessiona TodoLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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
osid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoLookupSessiona TodoLookupSession
ErrorsNOT_FOUNDno Checklist found by the given Id
NULL_ARGUMENT checklistId or proxy 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoQuerySessiona TodoQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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
osid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoQuerySessiona TodoQuerySession
ErrorsNOT_FOUNDno Todo found by the given Id
NULL_ARGUMENT checklistId or proxy 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoSearchSessiona TodoSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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
osid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoSearchSessiona TodoSearchSession
ErrorsNOT_FOUNDno Todo found by the given Id
NULL_ARGUMENT checklistId or proxy 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoAdminSessiona TodoAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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
osid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoAdminSessiona TodoAdminSession
ErrorsNOT_FOUNDno Todo found by the given Id
NULL_ARGUMENT checklistId or proxy 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
osid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoNotificationSessiona TodoNotificationSession
ErrorsNULL_ARGUMENT todoReceiver or proxy 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
osid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoNotificationSessiona TodoNotificationSession
ErrorsNOT_FOUNDno Todo found by the given Id
NULL_ARGUMENT todoReceiver, checklistId or proxy 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.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.checklist.TodoHierarchySession a TodoHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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
osid.proxy.Proxyproxyproxy
Returnosid.checklist.TodoHierarchySession a TodoHierarchySession
ErrorsNOT_FOUNDno checklist found by the given Id
NULL_ARGUMENT checklistId or proxy 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.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.checklist.TodoHierarchyDesignSessiona TodoHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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.IdchecklistIdthe Id of the Checklist
osid.proxy.Proxyproxyproxy
Returnosid.checklist.TodoHierarchyDesignSessiona TodoHierarchyDesignSession
ErrorsNOT_FOUNDno checklist found by the given Id
NULL_ARGUMENT checklistId or proxy 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoChecklistSessiona TodoChecklistSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoChecklistAssignmentSessiona TodoChecklistAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTodoChecklistAssignment() is false
ComplianceoptionalThis method must be implemented if supportsTodoChecklistAssignment() is true.
MethodgetTodoSmartChecklistSession
Description

Gets the session for managing dynamic todo checklists for the given checklist.

Parametersosid.id.IdchecklistIdthe Id of a checklist
osid.proxy.Proxyproxya proxy
Returnosid.checklist.TodoSmartChecklistSession checklistId not found
ErrorsNOT_FOUND checklistId or proxy is null
NULL_ARGUMENT checklistId or proxy 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.ChecklistLookupSessiona ChecklistLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.ChecklistQuerySessiona ChecklistQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistQueryh() is false
ComplianceoptionalThis method must be implemented if supportsChecklistQuery() is true.
MethodgetChecklistSearchSession
Description

Gets the OsidSession associated with the checklist search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.ChecklistSearchSessiona ChecklistSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.ChecklistAdminSessiona ChecklistAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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
osid.proxy.Proxyproxya proxy
Returnosid.checklist.ChecklistNotificationSessiona ChecklistNotificationSession
ErrorsNULL_ARGUMENT checklistReceiver or proxy 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.ChecklistHierarchySessiona ChecklistHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.checklist.ChecklistHierarchyDesignSessiona ChecklistHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsChecklistHierarchyDesign() is true.
MethodgetChecklistBatchProxyManager
Description

Gets a ChecklistBatchProxyManager.

Returnosid.checklist.batch.ChecklistBatchProxyManagera ChecklistBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsChecklistBatch() is false
ComplianceoptionalThis method must be implemented if supportsChecklistBatch() is true.
MethodgetChecklistMasonProxyManager
Description

Gets a ChecklistMasonProxyManager.

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