OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.RegistrationSearch
Implementsosid.OsidSearch
Description

The search interface for governing registration searches.

MethodsearchAmongRegistrations
Description

Execute this search among the given list of registrations.

Parametersosid.id.IdListregistrationIdslist of courses
ErrorsNULL_ARGUMENT registrationIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRegistrationResults
Description

Specify an ordering to the search results.

Parametersosid.course.registration.RegistrationSearchOrderregistrationSearchOrdercourse search order
ErrorsNULL_ARGUMENT registrationSearchOrder is null
UNSUPPORTED registrationSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationSearchRecord
Description

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

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