OSID Logo
OSID Specifications
course registration request package
Version 3.1.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.

Returnboolean false if looking up mappings is not authorized, true otherwise
Compliancemandatory This 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.

Compliancemandatory This 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.

Compliancemandatory This method is must be implemented.
MethodgetRegistrationRequestItemIdsByCourseCatalog
Description

Gets the list of RegistrationRequestItemIds associated with a CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of the CourseCatalog
Returnosid.id.IdList list of related registration request item Ids
ErrorsNOT_FOUND courseCatalogId is not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetRegistrationRequestItemsByCourseCatalog
Description

Gets the list of RegistrationRequestItems associated with a CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of the CourseCatalog
Returnosid.course.registration.request.RegistrationRequestItemList list of related registration request items
ErrorsNOT_FOUND courseCatalogId is not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetRegistrationRequestItemIdsByCourseCatalogs
Description

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

Parametersosid.id.IdListcourseCatalogIds list of course catalog Ids
Returnosid.id.IdList list of registration request item Ids
ErrorsNULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetRegistrationRequestItemsByCourseCatalogs
Description

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

Parametersosid.id.IdListcourseCatalogIds list of course catalog Ids
Returnosid.course.registration.request.RegistrationRequestItemList list of registration request items
ErrorsNULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetCourseCatalogIdsByRegistrationRequestItem
Description

Gets the CourseCatalog Ids mapped to a RegistrationRequestItem.

Parametersosid.id.IdregistrationRequestItemId Id of a RegistrationRequestItem
Returnosid.id.IdList list of course catalog Ids
ErrorsNOT_FOUND registrationRequestItemId is not found
NULL_ARGUMENT registrationRequestItemId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetCourseCatalogsByRegistrationRequestItem
Description

Gets the CourseCatalogs mapped to a RegistrationRequestItem.

Parametersosid.id.IdregistrationRequestItemId Id of a RegistrationRequestItem
Returnosid.course.CourseCatalogList list of course catalogs
ErrorsNOT_FOUND registrationRequestItemId is not found
NULL_ARGUMENT registrationRequestItemId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.