OSID - osid.learning.ActivityLookupSession Service Interface Definition

Interface	osid.learning.ActivityLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Activity` objects. The `Activity` represents something to perform in order to achieve a learning objective. 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 activity methods in this session operate, retrieve and pertain to activities defined explicitly in the current objective bank. Using an isolated view is useful for managing activities with the `ActivityAdminSession.` federated objective bank view: All activity methods in this session operate, retrieve and pertain to all activities defined in this objective bank and any other objective banks implicitly available in this objective bank through objective bank inheritence. Activities may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Activity.`
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	canLookupActivities
Description	Tests if this user can perform `Activity` 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	useComparativeActivityView
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	usePlenaryActivityView
Description	A complete view of the `Activity` 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 activities 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	getActivity
Description	Gets the `Activity` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Activity` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Activity` and retained for compatibility.
Parameters	`osid.id.Id`	`activityId`	`Id` of the `Activity`
Return	`osid.learning.Activity`		the activity
Errors	NOT_FOUND		`activityId` not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getActivitiesByIds
Description	Gets an `ActivityList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the activities 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 `Activities` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`activityIds`	the list of `Ids` to retrieve
Return	`osid.learning.ActivityList`		the returned `Activity` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`activityIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesByGenusType
Description	Gets an `ActivityList` corresponding to the given activity genus `Type` which does not include activities of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session.
Parameters	`osid.type.Type`	`activityGenusType`	an activity genus type
Return	`osid.learning.ActivityList`		the returned `Activity` list
Errors	NULL_ARGUMENT		`activityGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesByParentGenusType
Description	Gets an `ActivityList` corresponding to the given activity genus `Type` and include any additional activity with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session.
Parameters	`osid.type.Type`	`activityGenusType`	an activity genus type
Return	`osid.learning.ActivityList`		the returned `Activity` list
Errors	NULL_ARGUMENT		`activityGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesByRecordType
Description	Gets a `ActivityList` containing the given activity record `Type.` In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session.
Parameters	`osid.type.Type`	`activityRecordType`	an activity record type
Return	`osid.learning.ActivityList`		the returned `Activity` list
Errors	NULL_ARGUMENT		`activityRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesForObjective
Description	Gets the activities for the given objective. In plenary mode, the returned list contains all of the activities mapped to the objective `Id` or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible `Activities` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.Id`	`objectiveId`	`Id` of the `Objective`
Return	`osid.learning.ActivityList`		list of enrollments
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	getActivitiesForObjectives
Description	Gets the activities for the given objectives. In plenary mode, the returned list contains all of the activities specified in the objective `Id` list, in the order of the list, including duplicates, or an error results if a course offering `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Activities` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`objectiveIds`	list of objective `Ids`
Return	`osid.learning.ActivityList`		list of activities
Errors	NOT_FOUND		an `objectiveId` not found
	NULL_ARGUMENT		`objectiveIdList` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getActivitiesByAsset
Description	Gets the activities for the given asset. In plenary mode, the returned list contains all of the activities mapped to the asset `Id` or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Activities` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.Id`	`assetId`	`Id` of an `Asset`
Return	`osid.learning.ActivityList`		list of activities
Errors	NOT_FOUND		`assetId` not found
	NULL_ARGUMENT		`assetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getActivitiesByAssets
Description	Gets the activities for the given asset. In plenary mode, the returned list contains all of the activities mapped to the asset `Id` or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Activities` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`assetIds`	`Ids` of `Assets`
Return	`osid.learning.ActivityList`		list of activities
Errors	NOT_FOUND		an `assetId` not found
	NULL_ARGUMENT		`assetIdList` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getActivities
Description	Gets all `Activities.` In plenary mode, the returned list contains all known activites or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session.
Return	`osid.learning.ActivityList`		a `ActivityList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.