OSID Logo
OSID Specifications
course registration package
Version 3.1.0
Interfaceosid.course.registration.RegistrationTargetSearch
Implementsosid.OsidSearch
Used Byosid.course.registration.RegistrationTargetSearchSession
Description

The search interface for governing registration target searches.

MethodsearchAmongRegistrationTargets
Description

Execute this search among the given list of registration targets.

Parametersosid.id.IdListregistrationTargetIds list of registration targets
ErrorsNULL_ARGUMENT registrationTargetIds is null
Compliancemandatory This method must be implemented.
MethodorderRegistrationTargetResults
Description

Specify an ordering to the search results.

Parametersosid.course.registration.RegistrationTargetSearchOrderregistrationTargetSearchOrder registration target search order
ErrorsNULL_ARGUMENT registrationTargetSearchOrder is null
UNSUPPORTED registrationTargetSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetRegistrationTargetSearchRecord
Description

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

Parametersosid.type.TyperegistrationTargetSearchRecordType a registration target search record type
Returnosid.course.registration.records.RegistrationTargetSearchRecord the registration target search record
ErrorsNULL_ARGUMENT registrationTargetSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(registrationTargetSearchRecordType) is false
Compliancemandatory This method must be implemented.