OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.EnrollmentSearchSession
Implementsosid.course.program.EnrollmentQuerySession
Description

This session provides methods for searching among Enrollment objects. The search query is constructed using the EnrollmentQuery.

getEnrollmentsByQuery() is the basic search method and returns a list of Enrollments. A more advanced search may be performed with getEnrollmentsBySearch(). It accepts an EnrollmentSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getEnrollmentsBySearch() returns an EnrollmentSearchResults that can be used to access the resulting EnrollmentList or be used to perform a search within the result set through EnrollmentSearch.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include enrollments in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to enrollments in this course catalog

Enrollments may have a query record indicated by their respective record types. The query record is accessed via the EnrollmentQuery.

MethodgetEnrollmentSearch
Description

Gets an enrollment search.

Returnosid.course.program.EnrollmentSearchthe enrollment search
CompliancemandatoryThis method must be implemented.
MethodgetEnrollmentSearchOrder
Description

Gets an enrollment search order. The EnrollmentSearchOrder is supplied to an EnrollmentSearch to specify the ordering of results.

Returnosid.course.program.EnrollmentSearchOrderthe enrollment search order
CompliancemandatoryThis method must be implemented.
MethodgetEnrollmentsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.course.program.EnrollmentQueryenrollmentQuerythe enrollment query
osid.course.program.EnrollmentSearchenrollmentSearchthe enrollment search
Returnosid.course.program.EnrollmentSearchResultsthe returned search results
ErrorsNULL_ARGUMENT enrollmentQuery or enrollmentSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED enrollmentQuery or enrollmentSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEnrollmentQueryFromInspector
Description

Gets an enrollment query from an inspector. The inspector is available from an EnrollmentSearchResults.

Parametersosid.assessment.ItemQueryInspectorenrollmentQueryInspectoran enrollment query inspector
Returnosid.course.program.EnrollmentQuerythe enrollment query
ErrorsNULL_ARGUMENT enrollmentQueryInspector is null
UNSUPPORTED enrollmentQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.