OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.EnrollmentSearch
Implementsosid.OsidSearch
Description

The search interface for governing enrollment searches.

MethodsearchAmongEnrollments
Description

Execute this search among the given list of enrollments.

Parametersosid.id.IdListenrollmentIdslist of enrollments
ErrorsNULL_ARGUMENT enrollmentIds is null
CompliancemandatoryThis method must be implemented.
MethodorderEnrollmentResults
Description

Specify an ordering to the search results.

Parametersosid.course.program.EnrollmentSearchOrderenrollmentSearchOrderenrollment search order
ErrorsNULL_ARGUMENT enrollmentSearchOrder is null
UNSUPPORTED enrollmentSearchOrder is not of this service
CompliancemandatoryThis 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.TypeenrollmentSearchRecordTypean enrollment search record type
Returnosid.course.program.records.EnrollmentSearchRecordthe enrollment search record
ErrorsNULL_ARGUMENT enrollmentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(enrollmentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.