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

This session provides methods for searching among RegistrationRequestItems. The search query is constructed using the RegistrationRequestItemQuery.

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

This session defines views that offer differing behaviors for searching.

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

Registration Request Items may have a query record indicated by their respective record types. The quer y record is accessed via the RegistrationRequestItemQuery .

MethodgetRegistrationRequestItemSearch
Description

Gets a registration request item search.

Returnosid.course.registration.request.RegistrationRequestItemSearch the registration request item search
Compliancemandatory This method must be implemented.
MethodgetRegistrationRequestItemSearchOrder
Description

Gets a registration request item search order. The RegistrationRequestItemSearchOrder is supplied to a RegistrationRequestItemSearch to specify the ordering of results.

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

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

Parametersosid.course.registration.request.RegistrationRequestItemQueryregistrationRequestItemQuery the registration request item query
osid.course.registration.request.RegistrationRequestItemSearchregistrationRequestItemSearch the registration request item search
Returnosid.course.registration.request.RegistrationRequestItemSearchResults the returned search results
ErrorsNULL_ARGUMENT registrationRequestItemQuery or registrationRequestItemSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED registrationRequestItemQuery or registrationRequestItemSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetRegistrationRequestItemQueryFromInspector
Description

Gets a registration request item query from an inspector. The inspector is available from a RegistrationRequestItemSearchResults.

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.