OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.RegistrationSearchSession
Implementsosid.course.registration.RegistrationQuerySession
Description

This session provides methods for searching among Registration objects. The search query is constructed using the RegistrationQuery.

getRegistrationsByQuery() is the basic search method and returns a list of Registrations. A more advanced search may be performed with getRegistrationsBySearch(). It accepts a RegistrationSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRegistrationsBySearch() returns a RegistrationSearchResults that can be used to access the resulting RegistrationList or be used to perform a search within the result set through RegistrationSearch.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include registrations in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to registrations in this course catalog

Registrations may have a query record indicated by their respective record types. The query record is accessed via the RegistrationQuery.

MethodgetRegistrationSearch
Description

Gets a registration search.

Returnosid.course.registration.RegistrationSearchthe registration search
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationSearchOrder
Description

Gets a registration search order. The RegistrationSearchOrder is supplied to a RegistrationSearch to specify the ordering of results.

Returnosid.course.registration.RegistrationSearchOrderthe registration search order
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.course.registration.RegistrationQueryregistrationQuerythe registration query
osid.course.registration.RegistrationSearchregistrationSearchthe registration search
Returnosid.course.registration.RegistrationSearchResultsthe returned search results
ErrorsNULL_ARGUMENT registrationQuery or registrationSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED registrationQuery or registrationSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationQueryFromInspector
Description

Gets a registration query from an inspector. The inspector is available from a RegistrationSearchResults.

Parametersosid.assessment.ItemQueryInspectorregistrationQueryInspectora registration query inspector
Returnosid.course.registration.RegistrationQuerythe registration query
ErrorsNULL_ARGUMENT registrationQueryInspector is null
UNSUPPORTED registrationQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.