org.osid.course.program

Interface EnrollmentSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, EnrollmentQuerySession, OsidSession

public interface EnrollmentSearchSession
extends EnrollmentQuerySession

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.

Method Summary

Methods

Modifier and Type	Method and Description
EnrollmentQuery	getEnrollmentQueryFromInspector(ItemQueryInspector enrollmentQueryInspector) Gets an enrollment query from an inspector.
EnrollmentSearchResults	getEnrollmentsBySearch(EnrollmentQuery enrollmentQuery, EnrollmentSearch enrollmentSearch) Gets the search results matching the given search query using the given search.
EnrollmentSearch	getEnrollmentSearch() Gets an enrollment search.
EnrollmentSearchOrder	getEnrollmentSearchOrder() Gets an enrollment search order.

Methods inherited from interface org.osid.course.program.EnrollmentQuerySession

canSearchEnrollments, getCourseCatalog, getCourseCatalogId, getEnrollmentQuery, getEnrollmentsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getEnrollmentSearch

EnrollmentSearch getEnrollmentSearch()

Gets an enrollment search.

Returns:

the enrollment search

Compliance:

mandatory - This method must be implemented.

getEnrollmentSearchOrder

EnrollmentSearchOrder getEnrollmentSearchOrder()

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

Returns:

the enrollment search order

Compliance:

mandatory - This method must be implemented.

getEnrollmentsBySearch

EnrollmentSearchResults getEnrollmentsBySearch(EnrollmentQuery enrollmentQuery,
                                             EnrollmentSearch enrollmentSearch)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

enrollmentQuery - the enrollment query

enrollmentSearch - the enrollment search

Returns:

the returned search results

Throws:

NullArgumentException - enrollmentQuery or enrollmentSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - enrollmentQuery or enrollmentSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getEnrollmentQueryFromInspector

EnrollmentQuery getEnrollmentQueryFromInspector(ItemQueryInspector enrollmentQueryInspector)

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

Parameters:

enrollmentQueryInspector - an enrollment query inspector

Returns:

the enrollment query

Throws:

NullArgumentException - enrollmentQueryInspector is null

UnsupportedException - enrollmentQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.