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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RegistrationReques tItemQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of RegistrationReq uestItems. The registration request items may be sequenced using the RegistrationRequestItemS earchOrder from this session.

This CourseCatalog has a default query that matches any registration request item and a default search order that specifies no sequencing. The queries may be examined using a RegistrationRequestItemQuery Inspector. The query may be modified by converting the inspector back to a RegistrationRequestItemQ uery.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Id the CourseCatalog Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalog the course catalog
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanManageSmartCourseCatalogs
Description

Tests if this user can manage smart course catalogs. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED.This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returnboolean false if smart course catalog management is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetRegistrationRequestItemQuery
Description

Gets a registration request item query.

Returnosid.course.registration.request.RegistrationRequestItemQuery the registration request item query
Compliancemandatory This method must be implemented.
MethodgetRegistrationRequestItemSearchOrder
Description

Gets a registration request item search order.

Returnosid.course.registration.request.RegistrationRequestItemSearchOrder the registration request item search order
Compliancemandatory This method must be implemented.
MethodapplyRegistrationRequestItemQuery
Description

Applies a registration request item query to this course catalog.

Parametersosid.course.registration.request.RegistrationRequestItemQueryregistrationRequestItemQuery the registration request item query
ErrorsNULL_ARGUMENT registrationRequestItemQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED registrationRequestItemQuery not of this service
Compliancemandatory This method must be implemented.
MethodinspectRegistrationRequestItemQuery
Description

Gets a registration request item query inspector for this course catalog.

Returnosid.course.registration.request.RegistrationRequestItemQueryInspector the registration request item query inspector
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
Compliancemandatory This method must be implemented.
MethodapplyRegistrationRequestItemSequencing
Description

Applies a registration request item search order to this course catalog.

Parametersosid.course.registration.request.RegistrationRequestItemSearchOrderregistrationRequestItemSearchOrder the registration request item search order
ErrorsNULL_ARGUMENT registrationRequestItemSearchOrder is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED registrationRequestItemSearchOrder not of this service
Compliancemandatory This method must be implemented.
MethodgetRegistrationRequestItemQueryFromInspector
Description

Gets a registration request item query from an inspector.

Parametersosid.course.registration.request.RegistrationRequestItemQueryInspectorregistrationRequestItemQueryInspector a registration request item query inspector
Returnosid.course.registration.request.RegistrationRequestItemQuery the registration request item query
ErrorsNULL_ARGUMENT registrationRequestItemQueryInspector is null
UNSUPPORTED registrationRequestItemQueryInspector is not of this service
Compliancemandatory This method must be implemented.