OSID - osid.checklist.mason.ChecklistMasonProxyManager Service Interface Definition

Interface	osid.checklist.mason.ChecklistMasonProxyManager
Implements	`osid.OsidProxyManager`
Implements	`osid.checklist.mason.ChecklistMasonProfile`
Description	The checklist mason proxy manager provides access to checklist mason sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a `Proxy` for passing information from server environments. 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
Method	getTodoProducerLookupSession
Description	Gets the `OsidSession` associated with the todo producer lookup service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerLookupSession`		a `TodoProducerLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	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 `OsidSession` associated with the todo producer lookup service for the given checklist.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerLookupSession`		a `TodoProducerLookupSession`
Errors	NOT_FOUND		no `Checklist` found by the given `Id`
	NULL_ARGUMENT		`checklistId or proxy 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 `OsidSession` associated with the todo producer query service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerQuerySession`		a `TodoProducerQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	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 `OsidSession` associated with the todo producer query service for the given checklist.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerQuerySession`		a `TodoProducerQuerySession`
Errors	NOT_FOUND		no `Checklist` found by the given `Id`
	NULL_ARGUMENT		`checklistId or proxy 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 `OsidSession` associated with the todo producer search service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerSearchSession`		a `TodoProducerSearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	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 `OsidSession` associated with the todo producers earch service for the given checklist.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerSearchSession`		a `TodoProducerSearchSession`
Errors	NOT_FOUND		no `Checklist` found by the given `Id`
	NULL_ARGUMENT		`checklistId or proxy 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 `OsidSession` associated with the todo producer administration service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerAdminSession`		a `TodoProducerAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	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 `OsidSession` associated with the todo producer administration service for the given checklist.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerAdminSession`		a `TodoProducerAdminSession`
Errors	NOT_FOUND		no `Checklist` found by the given `Id`
	NULL_ARGUMENT		`checklistId or proxy 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 `OsidSession` associated with the todo producer notification service.
Parameters	`osid.checklist.mason.TodoProducerReceiver`	`todoProducerReceiver`	the notification callback
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerNotificationSession`		a `TodoProducerNotificationSession`
Errors	NULL_ARGUMENT		`todoProducerReceiver` or `proxy` 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 `OsidSession` associated with the todo producer notification service for the given checklist.
Parameters	`osid.checklist.mason.TodoProducerReceiver`	`todoProducerReceiver`	the notification callback
	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerNotificationSession`		a `TodoProducerNotificationSession`
Errors	NOT_FOUND		no checklist found by the given `Id`
	NULL_ARGUMENT		`todoProducerReceiver, checklistId` or `proxy` 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 `OsidSession` to lookup todo producer/checklist mappings for todo producers.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerChecklistSession`		a `TodoProducerChecklistSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	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 `OsidSession` associated with assigning todo producers to checklists for todo.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerChecklistAssignmentSession`		a `TodoProducerChecklistAssignmentSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	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 `OsidSession` to manage todo producer smart checklists.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.checklist.mason.TodoProducerSmartChecklistSession`		a `TodoProducerSmartChecklistSession`
Errors	NOT_FOUND		no `Checklist` found by the given `Id`
	NULL_ARGUMENT		`checklistId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTodoProducerSmartChecklist()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTodoProducerSmartChecklist()` is `true.`