OSID Logo
OSID Specifications
course program package
Version 3.1.0
Interfaceosid.course.program.EnrollmentSearchResults
Implementsosid.OsidSearchResults
Used Byosid.course.program.EnrollmentSearchSession
Description

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

MethodgetEnrollments
Description

Gets the enrollment list resulting from a search.

Returnosid.course.program.EnrollmentList the enrollment list
ErrorsILLEGAL_STATE the enrollment list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetEnrollmentQueryInspector
Description

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

Returnosid.course.program.EnrollmentQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetEnrollmentSearchResultsRecord
Description

Gets the enrollment search results 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.EnrollmentSearchResultsRecord the enrollment search interface
ErrorsNULL_ARGUMENT enrollmentSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(enrollmentSearchRecordType) is false
Compliancemandatory This method must be implemented.