OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.EnrollmentSearchResults
Implementsosid.OsidSearchResults
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.EnrollmentListthe enrollment list
ErrorsILLEGAL_STATEthe enrollment list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetEnrollmentQueryInspector
Description

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

Returnosid.course.program.EnrollmentQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypeenrollmentSearchRecordTypean enrollment search record type
Returnosid.course.program.records.EnrollmentSearchResultsRecordthe enrollment search interface
ErrorsNULL_ARGUMENT enrollmentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(enrollmentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.