OSID - osid.course.ActivityUnitLookupSession Service Interface Definition

Interface	osid.course.ActivityUnitLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving activity units. An `ActivityUnit` is derived from a `Course` and maps to an offering time and registered students. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated course catalog view: All activity unit methods in this session operate, retrieve and pertain to activity units defined explicitly in the current course catalog. Using an isolated view is useful for managing `ActivityUnits` with the `ActivityUnitAdminSession.` federated course catalog view: All activity unit lookup methods in this session operate, retrieve and pertain to all activity units defined in this course catalog and any other activity units implicitly available in this course catalog through course catalog inheritence. active activity unit view: All activity unit lookup methods return activity units which are active. any active activity unit view: Activity units of any active or inactive status are returned from methods. The methods `useFederatedCourseCatalogView()` and `useIsolatedCourseCatalogView()` behave as a radio group and one should be selected before invoking any lookup methods. Activity units may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `ActivityUnit.`
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupActivityUnits
Description	Tests if this user can perform `ActivityUnit` 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 not 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	useComparativeActivityUnitView
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	usePlenaryActivityUnitView
Description	A complete view of the `ActivityUnit` 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	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include activity units in catalogs which are children of this catalog in the course catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCourseCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveActivityUnitView
Description	Only active activity units are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusActivityUnitView
Description	All activity units of any active or inactive status are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getActivityUnit
Description	Gets the `ActivityUnit` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `ActivityUnit` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `ActivityUnit` and retained for compatibility. In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned.
Parameters	`osid.id.Id`	`activityUnitId`	the `Id` of the `ActivityUnit` to retrieve
Return	`osid.course.ActivityUnit`		the returned `ActivityUnit`
Errors	NOT_FOUND		no `ActivityUnit` found with the given `Id`
	NULL_ARGUMENT		`activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitsByIds
Description	Gets an `ActivityUnitList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the activity units 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 `ActivityUnits` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned.
Parameters	`osid.id.IdList`	`activityUnitIds`	the list of `Ids` to retrieve
Return	`osid.course.ActivityUnitList`		the returned `ActivityUnit` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`activityUnitIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitsByGenusType
Description	Gets an `ActivityUnitList` corresponding to the given activity unit genus `Type` which does not include activity units of types derived from the specified `Type` . In plenary mode, the returned list contains all known activity units or an error results. Otherwise, the returned list may contain only those activity units that are accessible through this session. In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned.
Parameters	`osid.type.Type`	`activityUnitGenusType`	an activity unit genus type
Return	`osid.course.ActivityUnitList`		the returned `ActivityUnit` list
Errors	NULL_ARGUMENT		`activityUnitGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitsByParentGenusType
Description	Gets an `ActivityUnitList` corresponding to the given activity unit genus `Type` and include any additional activity units with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known activity units or an error results. Otherwise, the returned list may contain only those activity units that are accessible through this session. In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned.
Parameters	`osid.type.Type`	`activityUnitGenusType`	an activity unit genus type
Return	`osid.course.ActivityUnitList`		the returned `ActivityUnit` list
Errors	NULL_ARGUMENT		`activityUnitGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitsByRecordType
Description	Gets an `ActivityUnitList` containing the given activity unit record `Type.` In plenary mode, the returned list contains all known activity units or an error results. Otherwise, the returned list may contain only those activity units that are accessible through this session. In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned.
Parameters	`osid.type.Type`	`activityUnitRecordType`	an activity unit record type
Return	`osid.course.ActivityUnitList`		the returned `ActivityUnit` list
Errors	NULL_ARGUMENT		`activityUnitRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitsForCourse
Description	Gets an `ActivityUnitList` for the given course. In plenary mode, the returned list contains all known activity units or an error results. Otherwise, the returned list may contain only those activity units that are accessible through this session. In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned.
Parameters	`osid.id.Id`	`courseId`	a course `Id`
Return	`osid.course.ActivityUnitList`		the returned `ActivityUnit` list
Errors	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnits
Description	Gets all `ActivityUnits.` In plenary mode, the returned list contains all known activity units or an error results. Otherwise, the returned list may contain only those activity units that are accessible through this session. In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned.
Return	`osid.course.ActivityUnitList`		a list of `ActivityUnits`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.