OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.ActivityRegistrationLookupSession
Implementsosid.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.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupActivityRegistrations
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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeActivityRegistrationView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryActivityRegistrationView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedCourseCatalogView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethoduseEffectiveActivityRegistrationView
Description

Only activity registrations whose effective dates are current are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveActivityRegistrationView
Description

All activity registrations of any effective dates are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetActivityRegistration
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.

Parametersosid.id.IdactivityRegistrationIdthe Id of the ActivityRegistration to retrieve
Returnosid.course.registration.ActivityRegistrationthe returned ActivityRegistration
ErrorsNOT_FOUNDno ActivityRegistration found with the given Id
NULL_ARGUMENT activityRegistrationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsByIds
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.

Parametersosid.id.IdListactivityRegistrationIdsthe list of Ids to retrieve
Returnosid.course.registration.ActivityRegistrationListthe returned ActivityRegistration list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT activityRegistrationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsByGenusType
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.

Parametersosid.type.TypeactivityRegistrationGenusTypean activity registration genus type
Returnosid.course.registration.ActivityRegistrationListthe returned ActivityRegistration list
ErrorsNULL_ARGUMENT activityRegistrationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsByParentGenusType
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.

Parametersosid.type.TypeactivityRegistrationGenusTypean activity registration genus type
Returnosid.course.registration.ActivityRegistrationListthe returned ActivityRegistration list
ErrorsNULL_ARGUMENT activityRegistrationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsByRecordType
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.

Parametersosid.type.TypeactivityRegistrationRecordTypean activity registration record type
Returnosid.course.registration.ActivityRegistrationListthe returned ActivityRegistration list
ErrorsNULL_ARGUMENT activityRegistrationRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsOnDate
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.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForRegistration
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.

Parametersosid.id.IdregistrationIda registration Id
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsNULL_ARGUMENT registrationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForRegistrationOnDate
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.

Parametersosid.id.IdregistrationIda registration Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT registrationId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForActivity
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.

Parametersosid.id.IdactivityIdan activity Id
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsNULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForActivityOnDate
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.

Parametersosid.id.IdactivityIdan activity Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT activityId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForStudent
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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForStudentOnDate
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.

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForActivityAndStudent
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.

Parametersosid.id.IdactivityIdan activity Id
osid.id.IdresourceIda resource Id
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsNULL_ARGUMENT activityId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForActivityAndStudentOnDate
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.

Parametersosid.id.IdactivityIdan activity Id
osid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT activityId, resourceId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForCourseOffering
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.

Parametersosid.id.IdcourseOfferingIda course offering Id
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsNULL_ARGUMENT courseOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForCourseOfferingOnDate
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.

Parametersosid.id.IdcourseOfferingIda course offering Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT courseOfferingId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForCourseOfferingAndStudent
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.

Parametersosid.id.IdcourseOfferingIda course offering Id
osid.id.IdresourceIda resource Id
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsNULL_ARGUMENT courseOfferingId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsForCourseOfferingAndStudentOnDate
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.

Parametersosid.id.IdcourseOfferingIda course offering Id
osid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT courseOfferingId, resourceId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrations
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.

Returnosid.course.registration.ActivityRegistrationLista list of ActivityRegistrations
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.