OSID - osid.course.registration.ActivityRegistrationLookupSession Service Interface Definition

Interface	osid.course.registration.ActivityRegistrationLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving activity registrations. An `ActivityRegistration` is a relationship between a student and an `Activity.` `ActivityRegistrations` may be implied from a `Registration.` 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 registration methods in this session operate, retrieve and pertain to activity registrations defined explicitly in the current course catalog. Using an isolated view is useful for managing `ActivityRegistrations` with the `ActivityRegistrationAdminSession.` federated course catalog view: All activity registration lookup methods in this session operate, retrieve and pertain to all activity registrations defined in this course catalog and any other activity registrations implicitly available in this course catalog through course catalog inheritence. effective vote view: All activity registration lookup methods return registrations where the current date falls in between the effective dates inclusive. any effective vote view: Activity registrations of any effective date 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 registrations may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `ActivityRegistration.`
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	canLookupActivityRegistrations
Description	Tests if this user can perform `ActivityRegistration` 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	useComparativeActivityRegistrationView
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	usePlenaryActivityRegistrationView
Description	A complete view of the `ActivityRegistration` 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 registrations 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	useEffectiveActivityRegistrationView
Description	Only activity registrations whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveActivityRegistrationView
Description	All activity registrations of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getActivityRegistration
Description	Gets the `ActivityRegistration` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `ActivityRegistration` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Course` and retained for compatibility. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`activityRegistrationId`	the `Id` of the `ActivityRegistration` to retrieve
Return	`osid.course.registration.ActivityRegistration`		the returned `ActivityRegistration`
Errors	NOT_FOUND		no `ActivityRegistration` found with the given `Id`
	NULL_ARGUMENT		`activityRegistrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsByIds
Description	Gets an `ActivityRegistrationList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the activity registrations 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 `ActivityRegistrations` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.IdList`	`activityRegistrationIds`	the list of `Ids` to retrieve
Return	`osid.course.registration.ActivityRegistrationList`		the returned `ActivityRegistration` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`activityRegistrationIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsByGenusType
Description	Gets an `ActivityRegistrationList` corresponding to the given activity registration genus `Type` which does not include activity registrations of types derived from the specified `Type.` In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those activity registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.type.Type`	`activityRegistrationGenusType`	an activity registration genus type
Return	`osid.course.registration.ActivityRegistrationList`		the returned `ActivityRegistration` list
Errors	NULL_ARGUMENT		`activityRegistrationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsByParentGenusType
Description	Gets an `ActivityRegistrationList` corresponding to the given course genus `Type` and include any additional activity registrations with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those activity registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.type.Type`	`activityRegistrationGenusType`	an activity registration genus type
Return	`osid.course.registration.ActivityRegistrationList`		the returned `ActivityRegistration` list
Errors	NULL_ARGUMENT		`activityRegistrationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsByRecordType
Description	Gets an `ActivityRegistrationList` containing the given activity registration record `Type.` In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those activity registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.type.Type`	`activityRegistrationRecordType`	an activity registration record type
Return	`osid.course.registration.ActivityRegistrationList`		the returned `ActivityRegistration` list
Errors	NULL_ARGUMENT		`activityRegistrationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsOnDate
Description	Gets all `ActivityRegistrations` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
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	getActivityRegistrationsForRegistration
Description	Gets all `ActivityRegistrations` for a registration. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`registrationId`	a registration `Id`
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	NULL_ARGUMENT		`registrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsForRegistrationOnDate
Description	Gets all `ActivityRegistrations` for a registration and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`registrationId`	a registration `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`registrationId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsForActivity
Description	Gets all `ActivityRegistrations` associated with a given `Activity.` In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsForActivityOnDate
Description	Gets all `ActivityRegistrations` for the given activity and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`activityId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsForStudent
Description	Gets all `ActivityRegistrations` for a given student. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsForStudentOnDate
Description	Gets all `ActivityRegistrations` for a student during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsForActivityAndStudent
Description	Gets all `ActivityRegistrations` for a given activity and student. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	NULL_ARGUMENT		`activityId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsForActivityAndStudentOnDate
Description	Gets all `ActivityRegistrations` for an activity and student during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`activityId, resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsForCourseOffering
Description	Gets all `ActivityRegistrations` related to a course offering. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsForCourseOfferingOnDate
Description	Gets all `ActivityRegistrations` for a course offering effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`courseOfferingId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsForCourseOfferingAndStudent
Description	Gets all `ActivityRegistrations` for a given course offering and student. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	NULL_ARGUMENT		`courseOfferingId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationsForCourseOfferingAndStudentOnDate
Description	Gets all `ActivityRegistrations` for a course offering and student effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`courseOfferingId, resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrations
Description	Gets all `ActivityRegistrations.` In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those activity registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned.
Return	`osid.course.registration.ActivityRegistrationList`		a list of `ActivityRegistrations`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.