OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.RegistrationSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetRegistrations
Description

Gets the registration list resulting from a search.

Returnosid.course.registration.RegistrationListthe registration list
ErrorsILLEGAL_STATEthe registration list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.course.registration.RegistrationQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationSearchResultsRecord
Description

Gets the registration search results record corresponding to the given registration search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TyperegistrationSearchRecordTypea registration search record type
Returnosid.course.registration.records.RegistrationSearchResultsRecordthe registration search results record
ErrorsNULL_ARGUMENT registrationSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(registrationSearchRecordType) is false
CompliancemandatoryThis method must be implemented.