OSID - osid.course.ActivityUnravellingSession Service Interface Definition

Interface	osid.course.ActivityUnravellingSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving and expanding activities. 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. federated course catalog view: All activity event in this session operate, retrieve and pertain to all activities defined in this course catalog and any other cours ecatalogs implicitly available in this course catalog through course catalog inheritence.
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	canUnravelActviities
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	getExplicitActivityByActivity
Description	Gets the activity where the given activity `Id` was issued as part of a recurring series.
Parameters	`osid.id.Id`	`activityId`	`an activity Id`
Return	`osid.course.Activity`		the returned `Activity`
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getExplicitActivitiesByActivities
Description	Gets an `ActivityList` corresponding to the given event `IdList` where the activities were implcitly created from the recurring series. In plenary mode, the returned list contains all of the activities corresponding to the events 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.course.ActivityList`		the returned `Activity` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`eventIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	expandActivity
Description	Expands the given activity into a series of single-date activities In plenary mode, the returned list contains all of the activities in the series, including duplicates, or an error results. In comparative mode, activities may be omitted from the list and may present the elements in any order, including providing a unique set.
Parameters	`osid.id.Id`	`activityId`	`Id` of the `Activity`
Return	`osid.course.ActivityList`		the returned `Activity list`
Errors	NOT_FOUND		`activityId was` 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	expandActivityInDateRange
Description	Expands the given activity into a series of single-date activities that fall within the given date range inclusive. In plenary mode, the returned list contains all of the activities in the series, including duplicates, or an error results. In comparative mode, activities may be omitted from the list and may present the elements in any order, including providing a unique set.
Parameters	`osid.id.Id`	`activityId`	`Id` of the `Activity`
	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.course.ActivityList`		the returned `Activity list`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NOT_FOUND		`activityId was` 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	expandActivities
Description	Expands the given recurring activities into a series of single-date activities. In plenary mode, the returned list contains all of the activities in the series, including duplicates, or an error results. In comparative mode, activities may be omitted from the list and may present the elements in any order, including providing a unique set.
Parameters	`osid.id.IdList`	`activityIds`	the list of `Ids` to expand
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	expandActivitiesInDateRange
Description	Expands the given recurring activities into a series of single-date activities that fall within the given date range inclusive. In plenary mode, the returned list contains all of the activities in the series, including duplicates, or an error results. In comparative mode, activities may be omitted from the list and may present the elements in any order, including providing a unique set.
Parameters	`osid.id.Id`	`activityIds`	the list of `Ids` to expand
	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.course.ActivityList`		the returned `Activity list`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	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 is must be implemented.
Method	getActivitiesByDate
Description	Gets a list of normalized unexpanded activities where the given date falls within the span of a single activity meeting time. 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.calendaring.DateTime`	`datetime`	a date
Return	`osid.course.ActivityList`		the returned `Activity` list
Errors	NULL_ARGUMENT		`datetime` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivtiesInDateRange
Description	Gets a normalized list of unexpanded activities whose series falls entirely within the given 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.
Parameters	`osid.calendaring.DateTime`	`from`	start date
Parameters	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.course.ActivityList`		the returned `Activity` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	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	getNumberOfActivities
Description	Gets the number of activity meeting times in the recurring series.
Parameters	`osid.id.Id`	`activityId`	`Id` of the recurring `Activity`
Return	`cardinal`		the number of meeting times
Errors	NOT_FOUND		`activityId was` 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	getNumberOfActivitiesInDateRange
Description	Gets the number of activity meeting times in the recurring series between the given dates inclusive.
Parameters	`osid.id.Id`	`activityId`	`Id` of the recurring `Activity`
	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
Return	`cardinal`		the number of meeting times
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NOT_FOUND		`activityId was` 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.