Interface RegistrationSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, RegistrationQuerySession

public interface RegistrationSearchSession
extends RegistrationQuerySession

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

getRegistrationsByQuery() is the basic search method and returns a list of Registrations. A more advanced search may be performed with getRegistrationsBySearch().It accepts a RegistrationSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRegistrationsBySearch() returns a RegistrationSearchResults that can be used to access the resulting RegistrationList or be used to perform a search within the result set through RegistrationSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
RegistrationQuery	getRegistrationQueryFromInspector(ItemQueryInspector registrationQueryInspector)	Gets a registration query from an inspector.
RegistrationSearchResults	getRegistrationsBySearch(RegistrationQuery registrationQuery, RegistrationSearch registrationSearch)	Gets the search results matching the given search query using the given search.
RegistrationSearch	getRegistrationSearch()	Gets a registration search.
RegistrationSearchOrder	getRegistrationSearchOrder()	Gets a registration search order.

Methods inherited from interface Closeable

close

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.

Methods inherited from interface RegistrationQuerySession

canSearchRegistrations, getCourseCatalog, getCourseCatalogId, getRegistrationQuery, getRegistrationsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchRegistrations()	Tests if this user can perform Registration lookups.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
RegistrationQuery	getRegistrationQuery()	Gets a registration query.
RegistrationList	getRegistrationsByQuery(RegistrationQuery courseQuery)	Gets a list of Registrations matching the given registration query.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

Method Details

getRegistrationSearch

RegistrationSearch getRegistrationSearch()

Gets a registration search.

Returns:

the registration search

Compliance:

mandatory - This method must be implemented.

getRegistrationSearchOrder

RegistrationSearchOrder getRegistrationSearchOrder()

Gets a registration search order. The RegistrationSearchOrder is supplied to a RegistrationSearch to specify the ordering of results.

Returns:

the registration search order

Compliance:

mandatory - This method must be implemented.

getRegistrationsBySearch

RegistrationSearchResults getRegistrationsBySearch(RegistrationQuery registrationQuery,
 RegistrationSearch registrationSearch)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

registrationQuery - the registration query

registrationSearch - the registration search

Returns:

the returned search results

Throws:

NullArgumentException - registrationQuery or registrationSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - registrationQuery or registrationSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRegistrationQueryFromInspector

RegistrationQuery getRegistrationQueryFromInspector(ItemQueryInspector registrationQueryInspector)

Gets a registration query from an inspector. The inspector is available from a RegistrationSearchResults.

Parameters:

registrationQueryInspector - a registration query inspector

Returns:

the registration query

Throws:

NullArgumentException - registrationQueryInspector is null

UnsupportedException - registrationQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.