OSID Logo
OSID Specifications
course registration request package
Version 3.0.0
Interfaceosid.course.registration.request.RegistrationRequestItemCourseCatalogSession
Implementsosid.OsidSession
Used Byosid.course.registration.request.RegistrationRequestManager
osid.course.registration.request.RegistrationRequestProxyManager
Description

This session provides methods to retrieve RegistrationR equestItem to CourseCatalog mappings. A RegistrationR equestItem may appear in multiple CourseCatalog obj ects. Each course catalog may have its own authorizations governing who is allowed to look at it.

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
MethodcanLookupRegistrationRequestItemCourseCatalogMappings
Description

Tests if this user can perform lookups of registration request item/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnbooleanfalse if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeRegistrationRequestItemCourseCatalogView
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.
MethodusePlenaryRegistrationRequestItemCourseCatalogView
Description

A complete view of the RegistrationRequestItem and CourseCatalog 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.
MethodgetRegistrationRequestItemIdsByCourseCatalog
Description

Gets the list of RegistrationRequestItemIds associated with a CourseCatalog .

Parametersosid.id.IdcourseCatalogIdId of the CourseCatalog
Returnosid.id.IdListlist of related registration request item Ids
ErrorsNOT_FOUNDcourseCatalogId is not found
NULL_ARGUMENTcourseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationRequestItemsByCourseCatalog
Description

Gets the list of RegistrationRequestItems associated with a CourseCatalog .

Parametersosid.id.IdcourseCatalogIdId of the CourseCatalog
Returnosid.course.registration.request.RegistrationRequestItemListlist of related registration request items
ErrorsNOT_FOUNDcourseCatalogId is not found
NULL_ARGUMENTcourseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationRequestItemIdsByCourseCatalogs
Description

Gets the list of RegistrationRequestItemIds corresponding to a list of Course Catalogs .

Parametersosid.id.IdListcourseCatalogIdslist of course catalog Ids
Returnosid.id.IdListlist of registration request item Ids
ErrorsNULL_ARGUMENTcourseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationRequestItemsByCourseCatalogs
Description

Gets the list of RegistrationRequestItem corresponding to a list of Course Catalogs .

Parametersosid.id.IdListcourseCatalogIdslist of course catalog Ids
Returnosid.course.registration.request.RegistrationRequestItemListlist of registration request items
ErrorsNULL_ARGUMENTcourseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogIdsByRegistrationRequestItem
Description

Gets the CourseCatalog Ids mapped to a RegistrationRequestItem .

Parametersosid.id.IdregistrationRequestItemIdId of a RegistrationRequestItem
Returnosid.id.IdListlist of course catalog Ids
ErrorsNOT_FOUNDregistrationRequestItemId is not found
NULL_ARGUMENTregistrationRequestItemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByRegistrationRequestItem
Description

Gets the CourseCatalogs mapped to a RegistrationRequestItem .

Parametersosid.id.IdregistrationRequestItemIdId of a RegistrationRequestItem
Returnosid.course.CourseCatalogListlist of course catalogs
ErrorsNOT_FOUNDregistrationRequestItemId is not found
NULL_ARGUMENTregistrationRequestItemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.