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

Interface	osid.checklist.mason.TodoProducerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `TodoProducers.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated checklist view: All todo producer methods in this session operate, retrieve and pertain to todo producers defined explicitly in the current checklist. Using an isolated view is useful for managing `TodoProducers` with the `TodoProducerAdminSession.` federated checklist view: All todo producer methods in this session operate, retrieve and pertain to all todo producers defined in this checklist and any other todo producers implicitly available in this checklist through checklist inheritence. active todo producer view: All todo producer lookup methods return active todo producers. any status todo producer view: todo producers of any active and inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
Method	getChecklistId
Description	Gets the `Checklist` `Id` associated with this session.
Return	`osid.id.Id`		the `Checklist Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getChecklist
Description	Gets the `Checklist` associated with this session.
Return	`osid.checklist.Checklist`		the checklist
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupTodoProducers
Description	Tests if this user can perform `TodoProducers` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeTodoProducerView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryTodoProducerView
Description	A complete view of the `TodoProducer` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedChecklistView
Description	Federates the view for methods in this session. A federated view will include todo producers in checklists which are children of this checklist in the checklist hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedChecklistView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this checklist only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveTodoProducerView
Description	Only active todo producers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusTodoProducerView
Description	All active and inactive todo producers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getTodoProducer
Description	Gets the `TodoProducer` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `TodoProducer` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `TodoProducer` and retained for compatibility.
Parameters	`osid.id.Id`	`todoProducerId`	`Id` of the `TodoProducer`
Return	`osid.checklist.mason.TodoProducer`		the todo producer
Errors	NOT_FOUND		`todoProducerId` not found
	NULL_ARGUMENT		`todoProducerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getTodoProducersByIds
Description	Gets a `TodoProducerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the todo producers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `TodoProducers` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`todoProducerIds`	the list of `Ids` to retrieve
Return	`osid.checklist.mason.TodoProducerList`		the returned `TodoProducer` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`todoProducerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducersByGenusType
Description	Gets a `TodoProducerList` corresponding to the given todo producer genus `Type` which does not include todo producers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known todo producers or an error results. Otherwise, the returned list may contain only those todo producers that are accessible through this session.
Parameters	`osid.type.Type`	`todoProducerGenusType`	a todo producer genus type
Return	`osid.checklist.mason.TodoProducerList`		the returned `TodoProducer` list
Errors	NULL_ARGUMENT		`todoProducerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducersByParentGenusType
Description	Gets a `TodoProducerList` corresponding to the given todo producer genus `Type` and include any additional todo producers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known todo producers or an error results. Otherwise, the returned list may contain only those todo producers that are accessible through this session.
Parameters	`osid.type.Type`	`todoProducerGenusType`	a todo producer genus type
Return	`osid.checklist.mason.TodoProducerList`		the returned `TodoProducer` list
Errors	NULL_ARGUMENT		`todoProducerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducersByRecordType
Description	Gets a `TodoProducerList` containing the given todo producer record `Type.` In plenary mode, the returned list contains all known todo producers or an error results. Otherwise, the returned list may contain only those todo producers that are accessible through this session.
Parameters	`osid.type.Type`	`todoProducerRecordType`	a todo producer record type
Return	`osid.checklist.mason.TodoProducerList`		the returned `TodoProducer` list
Errors	NULL_ARGUMENT		`todoProducerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducerByTodo
Description	Gets a `TodoProducer` by `Todo.` In plenary mode, the returned list contains all known todo producers or an error results. Otherwise, the returned list may contain only those todo producers that are accessible through this session.
Parameters	`osid.id.Id`	`todoId`	a todo `Id`
Return	`osid.checklist.mason.TodoProducer`		the returned `TodoProducer`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NOT_FOUND		`todoId` is not found or has no producer
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducers
Description	Gets all `TodoProducers.` In plenary mode, the returned list contains all known todo producers or an error results. Otherwise, the returned list may contain only those todo producers that are accessible through this session.
Return	`osid.checklist.mason.TodoProducerList`		the returned `TodoProducer` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.