Interface EnrollmentSearchSession

All Superinterfaces:

AutoCloseable, Closeable, EnrollmentQuerySession, OsidSession, OsidSession

public interface EnrollmentSearchSession
extends EnrollmentQuerySession

This session provides methods for searching among Enrollments . 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface EnrollmentQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchEnrollments()	Tests if this user can perform Enrollment lookups.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
EnrollmentQuery	getEnrollmentQuery()	Gets an enrollment query.
EnrollmentList	getEnrollmentsByQuery(EnrollmentQuery enrollmentQuery)	Gets a list of Enrollments matching the given enrollment query.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.