OSID - osid.checklist.ChecklistManager Service Interface Definition

Interface	osid.checklist.ChecklistManager
Implements	`osid.OsidManager`
Implements	`osid.checklist.ChecklistProfile`
Used By	`osid.orchestration.OrchestrationManager`
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.
Method	getTodoLookupSession
Description	Gets the `OsidSession` associated with the todo lookup service.
Return	`osid.checklist.TodoLookupSession`		a `TodoLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTodoLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoLookup()` is `true`.
Method	getTodoLookupSessionForChecklist
Description	Gets the `OsidSession` associated with the todo lookup service for the given checklist.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
Return	`osid.checklist.TodoLookupSession`		a `TodoLookupSession`
Errors	NOT_FOUND		no `Checklist` found by the given `Id`
	NULL_ARGUMENT		`checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTodoLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoLookup()` and `supportsVisibleFederation()` are `true`
Method	getTodoQuerySession
Description	Gets the `OsidSession` associated with the todo query service.
Return	`osid.checklist.TodoQuerySession`		a `TodoQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTodoQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoQuery()` is `true`.
Method	getTodoQuerySessionForChecklist
Description	Gets the `OsidSession` associated with the todo query service for the given checklist.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
Return	`osid.checklist.TodoQuerySession`		a `TodoQuerySession`
Errors	NOT_FOUND		no `Checklist` found by the given `Id`
	NULL_ARGUMENT		`checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTodoQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoQuery()` and `supportsVisibleFederation()` are `true`
Method	getTodoSearchSession
Description	Gets the `OsidSession` associated with the todo search service.
Return	`osid.checklist.TodoSearchSession`		a `TodoSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTodoSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoSearch()` is `true`.
Method	getTodoSearchSessionForChecklist
Description	Gets the `OsidSession` associated with the todo search service for the given checklist.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
Return	`osid.checklist.TodoSearchSession`		a `TodoSearchSession`
Errors	NOT_FOUND		no `Checklist` found by the given `Id`
	NULL_ARGUMENT		`checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTodoSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoSearch()` and `supportsVisibleFederation()` are `true`
Method	getTodoAdminSession
Description	Gets the `OsidSession` associated with the todo administration service.
Return	`osid.checklist.TodoAdminSession`		a `TodoAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTodoAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoAdmin()` is `true`.
Method	getTodoAdminSessionForChecklist
Description	Gets the `OsidSession` associated with the todo administration service for the given checklist.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
Return	`osid.checklist.TodoAdminSession`		a `TodoAdminSession`
Errors	NOT_FOUND		no `Checklist` found by the given `Id`
	NULL_ARGUMENT		`checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTodoAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoAdmin()` and `supportsVisibleFederation()` are `true`
Method	getTodoNotificationSession
Description	Gets the `OsidSession` associated with the todo notification service.
Parameters	`osid.checklist.TodoReceiver`	`todoReceiver`	the receiver
Return	`osid.checklist.TodoNotificationSession`		a `TodoNotificationSession`
Errors	NULL_ARGUMENT		`todoReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTodoNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoNotification()` is `true`.
Method	getTodoNotificationSessionForChecklist
Description	Gets the `OsidSession` associated with the todo notification service for the given checklist.
Parameters	`osid.checklist.TodoReceiver`	`todoReceiver`	the receiver
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
Return	`osid.checklist.TodoNotificationSession`		a `TodoNotificationSession`
Errors	NOT_FOUND		no `Checklist` found by the given `Id`
	NULL_ARGUMENT		`todoReceiver` or `checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTodoNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoNotification()` and `supportsVisibleFederation()` are `true`
Method	getTodoHierarchySession
Description	Gets the todo hierarchy traversal session.
Return	`osid.checklist.TodoHierarchySession`		`a TodoHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTodoHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoHierarchy()` is `true`.
Method	getTodoHierarchySessionForChecklist
Description	Gets the todo hierarchy traversal session for the given checklist.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
Return	`osid.checklist.TodoHierarchySession`		`a TodoHierarchySession`
Errors	NOT_FOUND		no checklist found by the given `Id`
	NULL_ARGUMENT		`checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTodoHierarchy()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoHierarchy()` and `supportsVisibleFederation()` are `true`
Method	getTodoHierarchyDesignSession
Description	Gets the todo hierarchy design session.
Return	`osid.checklist.TodoHierarchyDesignSession`		a `TodoHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTodoHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoHierarchyDesign()` is `true`.
Method	getTodoHierarchyDesignSessionForChecklist
Description	Gets the todo hierarchy design session for the given checklist.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Checklist`
Return	`osid.checklist.TodoHierarchyDesignSession`		a `TodoHierarchyDesignSession`
Errors	NOT_FOUND		no checklist found by the given `Id`
	NULL_ARGUMENT		`checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTodoHierarchyDesign()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoHierarchyDesign()` and `supportsVisibleFederation()` are `true`
Method	getTodoChecklistSession
Description	Gets the session for retrieving todo to checklist mappings.
Return	`osid.checklist.TodoChecklistSession`		a `TodoChecklistSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTodoChecklist()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoChecklist()` is `true`.
Method	getTodoChecklistAssignmentSession
Description	Gets the session for assigning todo to checklist mappings.
Return	`osid.checklist.TodoChecklistAssignmentSession`		a `TodoChecklistAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTodoChecklistAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoChecklistAssignment()` is `true`.
Method	getTodoSmartChecklistSession
Description	Gets the session associated with the todo smart checklist for the given checklist.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the checklist
Return	`osid.checklist.TodoSmartChecklistSession`		a `TodoSmartChecklistSession`
Errors	NOT_FOUND		`checklistId` not found
	NULL_ARGUMENT		`checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTodoSmartChecklist()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoSmartChecklist()` is `true`.
Method	getChecklistLookupSession
Description	Gets the `OsidSession` associated with the checklist lookup service.
Return	`osid.checklist.ChecklistLookupSession`		a `ChecklistLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChecklistLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChecklistLookup()` is `true`.
Method	getChecklistQuerySession
Description	Gets the `OsidSession` associated with the checklist query service.
Return	`osid.checklist.ChecklistQuerySession`		a `ChecklistQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChecklistQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChecklistQuery()` is `true`.
Method	getChecklistSearchSession
Description	Gets the `OsidSession` associated with the checklist search service.
Return	`osid.checklist.ChecklistSearchSession`		a `ChecklistSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChecklistSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChecklistSearch()` is `true`.
Method	getChecklistAdminSession
Description	Gets the `OsidSession` associated with the checklist administrative service.
Return	`osid.checklist.ChecklistAdminSession`		a `ChecklistAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChecklistAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChecklistAdmin()` is `true`.
Method	getChecklistNotificationSession
Description	Gets the `OsidSession` associated with the checklist notification service.
Parameters	`osid.checklist.ChecklistReceiver`	`checklistReceiver`	the receiver
Return	`osid.checklist.ChecklistNotificationSession`		a `ChecklistNotificationSession`
Errors	NULL_ARGUMENT		`checklistReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsChecklistNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChecklistNotification()` is `true`.
Method	getChecklistHierarchySession
Description	Gets the `OsidSession` associated with the checklist hierarchy service.
Return	`osid.checklist.ChecklistHierarchySession`		a `ChecklistHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChecklistHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChecklistHierarchy()` is `true`.
Method	getChecklistHierarchyDesignSession
Description	Gets the `OsidSession` associated with the checklist hierarchy design service.
Return	`osid.checklist.ChecklistHierarchyDesignSession`		a `ChecklistHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChecklistHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChecklistHierarchyDesign()` is `true`.
Method	getChecklistBatchManager
Description	Gets a `ChecklistBatchManager`.
Return	`osid.checklist.batch.ChecklistBatchManager`		a `ChecklistBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChecklistBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChecklistBatch()` is `true`.
Method	getChecklistMasonManager
Description	Gets a `ChecklistMasonManager`.
Return	`osid.checklist.mason.ChecklistMasonManager`		a `ChecklistMasonManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsChecklistMason()` is `false`
Compliance	`optional`		This method must be implemented if `supportsChecklistMason()` is `true`.