OSID Logo
OSID Specifications
course program package
Version 3.1.0
Interfaceosid.course.program.EnrollmentSearch
Implementsosid.OsidSearch
Used Byosid.course.program.EnrollmentSearchSession
Description

The search interface for governing enrollment searches.

MethodsearchAmongEnrollments
Description

Execute this search among the given list of enrollments.

Parametersosid.id.IdListenrollmentIds list of enrollments
ErrorsNULL_ARGUMENT enrollmentIds is null
Compliancemandatory This method must be implemented.
MethodorderEnrollmentResults
Description

Specify an ordering to the search results.

Parametersosid.course.program.EnrollmentSearchOrderenrollmentSearchOrder enrollment search order
ErrorsNULL_ARGUMENT enrollmentSearchOrder is null
UNSUPPORTED enrollmentSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetEnrollmentSearchRecord
Description

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

Parametersosid.type.TypeenrollmentSearchRecordType an enrollment search record type
Returnosid.course.program.records.EnrollmentSearchRecord the enrollment search record
ErrorsNULL_ARGUMENT enrollmentSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(enrollmentSearchRecordType) is false
Compliancemandatory This method must be implemented.