OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.RegistrationLookupSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving registrations. A Registration is a relationship between a student and an ActivityBundle.

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 registration methods in this session operate, retrieve and pertain to registrations defined explicitly in the current course catalog. Using an isolated view is useful for managing Registrations with the RegistrationAdminSession.
  • federated course catalog view: All registration lookup methods in this session operate, retrieve and pertain to all registrations defined in this course catalog and any other courses implicitly available in this course catalog through course catalog inheritence.
  • effective registration view: All registration lookup methods return registrations where the current date falls in between the effective dates inclusive.
  • any effective registration view: 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.

Registrations may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Registration.

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.
MethodcanLookupRegistrations
Description

Tests if this user can perform Registration 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.
MethoduseComparativeRegistrationView
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.
MethodusePlenaryRegistrationView
Description

A complete view of the Registration 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 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.
MethoduseEffectiveRegistrationView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveRegistrationView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetRegistration
Description

Gets the Registration specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Registration 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, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.id.IdregistrationIdthe Id of the Registration to retrieve
Returnosid.course.registration.Registrationthe returned Registration
ErrorsNOT_FOUNDno Registration found with the given Id
NULL_ARGUMENT registrationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsByIds
Description

Gets a RegistrationList corresponding to the given IdList.

In plenary mode, the returned list contains all of the 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 Registrations may be omitted from the list and may present the elements in any order including returning a unique set.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.id.IdListregistrationIdsthe list of Ids to retrieve
Returnosid.course.registration.RegistrationListthe returned Registration list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT registrationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsByGenusType
Description

Gets a RegistrationList corresponding to the given registration genus Type which does not include registrations of types derived from the specified Type.

In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.type.TyperegistrationGenusTypea registration genus type
Returnosid.course.registration.RegistrationListthe returned Registration list
ErrorsNULL_ARGUMENT registrationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsByParentGenusType
Description

Gets a RegistrationList corresponding to the given course genus Type and include any additional registrations with genus types derived from the specified Type.

In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.type.TyperegistrationGenusTypea registration genus type
Returnosid.course.registration.RegistrationListthe returned Registration list
ErrorsNULL_ARGUMENT registrationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsByRecordType
Description

Gets a RegistrationList containing the given registration record Type.

In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.type.TyperegistrationRecordTypea registration record type
Returnosid.course.registration.RegistrationListthe returned Registration list
ErrorsNULL_ARGUMENT registrationRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsOnDate
Description

Gets all Registrations effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.registration.RegistrationLista list of Registrations
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.
MethodgetRegistrationsForActivityBundle
Description

Gets all Registrations associated with a given ActivityBundle.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

Parametersosid.id.IdactivityBundleIdan activity bundle Id
Returnosid.course.registration.RegistrationLista list of Registrations
ErrorsNULL_ARGUMENT activityBundleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsForActivityBundleOnDate
Description

Gets all Registrations effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.id.IdactivityBundleIdan activity bundle Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.registration.RegistrationLista list of Registrations
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT activityBundleId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsForStudent
Description

Gets all Registrations for a given student.

In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
Returnosid.course.registration.RegistrationLista list of Registrations
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsForStudentOnDate
Description

Gets all Registrations for a 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 registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective 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.RegistrationLista list of Registrations
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.
MethodgetRegistrationsForActivityBundleAndStudent
Description

Gets all Registrations for a given activity bundle and student.

In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.id.IdactivityBundleIdan activity bundle Id
osid.id.IdresourceIda resource Id
Returnosid.course.registration.RegistrationLista list of Registrations
ErrorsNULL_ARGUMENT activityBundleId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsForActivityBundleAndStudentOnDate
Description

Gets all Registrations for an activity bundle 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 registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.id.IdactivityBundleIdan activity bundle Id
osid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.registration.RegistrationLista list of Registrations
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT activityBundleId, resourceId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsForCourseOffering
Description

Gets all Registrations related to a course offering.

In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.id.IdcourseOfferingIda course offering Id
Returnosid.course.registration.RegistrationLista list of Registrations
ErrorsNULL_ARGUMENT courseOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsForCourseOfferingOnDate
Description

Gets all Registrations 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 registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective 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.RegistrationLista list of Registrations
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.
MethodgetRegistrationsForCourseOfferingAndStudent
Description

Gets all Registrations for a given course offering and student.

In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

Parametersosid.id.IdcourseOfferingIda course offering Id
osid.id.IdresourceIda resource Id
Returnosid.course.registration.RegistrationLista list of Registrations
ErrorsNULL_ARGUMENT courseOfferingId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsForCourseOfferingAndStudentOnDate
Description

Gets all Registrations 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 registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective 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.RegistrationLista list of Registrations
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.
MethodgetRegistrations
Description

Gets all Registrations.

In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session.

In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned.

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