OSID - osid.learning.ObjectiveLookupSession Service Interface Definition

Interface	osid.learning.ObjectiveLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Objective` s. 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 objective bank view: All objective methods in this session operate, retrieve and pertain to objectives defined explicitly in the current objective bank. Using an isolated view is useful for managing objectives with the `ObjectiveAdminSession.` federated objective bank view: All objective methods in this session operate, retrieve and pertain to all objectives defined in this objective bank and any other objective banks implicitly available in this objective bank through objective bank inheritence. Objectives may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Objective.`
Method	getObjectiveBankId
Description	Gets the `ObjectiveBank` `Id` associated with this session.
Return	`osid.id.Id`		the `ObjectiveBank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBank
Description	Gets the `ObjectiveBank` associated with this session.
Return	`osid.learning.ObjectiveBank`		the `ObjectiveBank` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupObjectives
Description	Tests if this user can perform `Objective` 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	useComparativeObjectiveView
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	usePlenaryObjectiveView
Description	A complete view of the `Objective` 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	useFederatedObjectiveBankView
Description	Federates the view for methods in this session. A federated view will include objectives in objective banks which are children of this objective bank in the objective bank hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedObjectiveBankView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this objective bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	getObjective
Description	Gets the `Objective` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Objective` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Objective` and retained for compatibility.
Parameters	`osid.id.Id`	`objectiveId`	`Id` of the `Objective`
Return	`osid.learning.Objective`		the objective
Errors	NOT_FOUND		`objectiveId` not found
	NULL_ARGUMENT		`objectiveId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getObjectivesByIds
Description	Gets an `ObjectiveList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the objectives 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 `Objectives` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`objectiveIds`	the list of `Ids` to retrieve
Return	`osid.learning.ObjectiveList`		the returned `Objective` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`objectiveIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getObjectivesByGenusType
Description	Gets an `ObjectiveList` corresponding to the given objective genus `Type` which does not include objectives of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known objectives or an error results. Otherwise, the returned list may contain only those objectives that are accessible through this session.
Parameters	`osid.type.Type`	`objectiveGenusType`	an objective genus type
Return	`osid.learning.ObjectiveList`		the returned `Objective` list
Errors	NULL_ARGUMENT		`objectiveGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getObjectivesByParentGenusType
Description	Gets an `ObjectiveList` corresponding to the given objective genus `Type` and include any additional objective with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known objectives or an error results. Otherwise, the returned list may contain only those objectives that are accessible through this session
Parameters	`osid.type.Type`	`objectiveGenusType`	an objective genus type
Return	`osid.learning.ObjectiveList`		the returned `Objective` list
Errors	NULL_ARGUMENT		`objectiveGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getObjectivesByRecordType
Description	Gets an `ObjectiveList` containing the given objective record `Type.` In plenary mode, the returned list contains all known objectives or an error results. Otherwise, the returned list may contain only those objectives that are accessible through this session.
Parameters	`osid.type.Type`	`objectiveRecordType`	an objective record type
Return	`osid.learning.ObjectiveList`		the returned `Objective` list
Errors	NULL_ARGUMENT		`objectiveRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getObjectives
Description	Gets all `Objectives.` In plenary mode, the returned list contains all known objectives or an error results. Otherwise, the returned list may contain only those objectives that are accessible through this session.
Return	`osid.learning.ObjectiveList`		an `ObjectiveList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.