OSID - osid.course.ActivityLookupSession Service Interface Definition

Interface	osid.course.ActivityLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Activity` objects. The `Activity` represents a time period in which courses are offered. 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 course catalog view: All activity methods in this session operate, retrieve and pertain to activities defined explicitly in the current course catalog. Using an isolated view is useful for managing `Activities` with the `ActivityAdminSession.` federated course catalog view: All activity methods in this session operate, retrieve and pertain to all activities defined in this course catalog and any other activities implicitly available in this course catalog through course catalog inheritence. effective activity view: All course offering lookup methods return activities where the current date falls within the effective dates inclusive. any effective activity view: Activities of any effective or expired status are returned from methods. denormalized activity view: activities are expanded into a series of non-recurring single-date activities normalized acticity view: activities are represented by a single activity 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 `useFederatedCourseCatalogView()` and `useIsolatedCourseCatalogView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	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	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include activities in course catalogs which are children of this course 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 lookups to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveActivityView
Description	All activity methods return activities where the current date falls within the effective dates inclusive.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveActivityView
Description	All methods return activities of any effective or expired status.
Compliance	`mandatory`		This method is must be implemented.
Method	useNormalizedActivityView
Description	A normalized view uses a single `Activity` to represent a set of recurring activities.
Compliance	`mandatory`		This method is must be implemented.
Method	useDenormalizedActivityView
Description	A denormalized view expands recurring activities into a series of activities.
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 an `Activity` and retained for compatibility. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.id.Id`	`activityId`	`Id` of the `Activity`
Return	`osid.course.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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.id.IdList`	`activityIds`	the list of `Ids` to retrieve
Return	`osid.course.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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.type.Type`	`activityGenusType`	an activity genus type
Return	`osid.course.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 activities 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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.type.Type`	`activityGenusType`	an activity genus type
Return	`osid.course.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 an `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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.type.Type`	`activityRecordType`	an activity record type
Return	`osid.course.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	getActivitiesOnDate
Description	Gets an `ActivityList` effective within the given date range inclusive. 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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.ActivityList`		the returned `Activity` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	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	getActivitiesForActivityUnit
Description	Gets all `Activities` associated with a given `ActivityUnit.` 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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
Return	`osid.course.ActivityList`		the returned `Activity` list
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesForActivityUnitOnDate
Description	Gets an `ActivityList` for the given activity unit and effective within the given date range inclusive. 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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.ActivityList`		the returned `Activity` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`activityUnitId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesForTerm
Description	Gets all `Activities` associated with a given term. 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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Return	`osid.course.ActivityList`		the returned `Activity` list
Errors	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesForTermOnDate
Description	Gets an `ActivityList` for the given term and effective within the given date range inclusive. 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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.id.Id`	`termId`	a term `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.ActivityList`		the returned `Activity` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`termId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesForActivityUnitAndTerm
Description	Gets all `Activities` associated with a given `ActivityUnit` for a term. 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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
Parameters	`osid.id.Id`	`termId`	a term `Id`
Return	`osid.course.ActivityList`		the returned `Activity` list
Errors	NULL_ARGUMENT		`activityUnitId` or `termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesForActivityUnitAndTermOnDate
Description	Gets an `ActivityList` for the given activity unit, term, and effective within the given date range inclusive. 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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
	`osid.id.Id`	`termId`	a term `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.ActivityList`		the returned `Activity` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`activityUnitId, termId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivitiesForCourseOffering
Description	Gets all `Activities` associated with a given `CourseOffering.` 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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	a course `Id`
Return	`osid.course.ActivityList`		the returned `Activity` list
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivities
Description	Gets all `Activities.` 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. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.
Return	`osid.course.ActivityList`		a list of `Activities`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.