Interface RequisiteSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, RequisiteQuerySession

public interface RequisiteSearchSession
extends RequisiteQuerySession

This session provides methods for searching among Requisites . The search query is constructed using the RequisiteQuery .

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
RequisiteQuery	getRequisiteQueryFromInspector(RequisiteQueryInspector requisiteQueryInspector)	Gets a requisite query from an inspector.
RequisiteSearchResults	getRequisitesBySearch(RequisiteQuery requisiteQuery, RequisiteSearch requisiteSearch)	Gets the search results matching the given search query using the given search.
RequisiteSearch	getRequisiteSearch()	Gets a requisite search.
RequisiteSearchOrder	getRequisiteSearchOrder()	Gets a requisite 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 RequisiteQuerySession

canSearchRequisites, getCourseCatalog, getCourseCatalogId, getRequisiteQuery, getRequisitesByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView, useSequesteredRequisiteView, useUnsequesteredRequisiteView

Modifier and Type	Method	Description
boolean	canSearchRequisites()	Tests if this user can perform Requisite searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
RequisiteQuery	getRequisiteQuery()	Gets a requisite query.
RequisiteList	getRequisitesByQuery(RequisiteQuery requisiteQuery)	Gets a list of Requisites matching the given requisite query.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.
void	useSequesteredRequisiteView()	The returns from the search methods omit sequestered requisites.
void	useUnsequesteredRequisiteView()	All requisites are returned including sequestered requisites.

Method Details

getRequisiteSearch

RequisiteSearch getRequisiteSearch()

Gets a requisite search.

Returns:

the requisite search

Compliance:

mandatory - This method must be implemented.

getRequisiteSearchOrder

RequisiteSearchOrder getRequisiteSearchOrder()

Gets a requisite search order. The RequisiteSearchOrder is supplied to a RequisiteSearch to specify the ordering of results.

Returns:

the requisite search order

Compliance:

mandatory - This method must be implemented.

getRequisitesBySearch

RequisiteSearchResults getRequisitesBySearch(RequisiteQuery requisiteQuery,
 RequisiteSearch requisiteSearch)
                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

requisiteQuery - the requisite query

requisiteSearch - the requisite search

Returns:

the requisite search results

Throws:

NullArgumentException - requisiteQuery or requisiteSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - requisiteQuery or requisiteSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRequisiteQueryFromInspector

RequisiteQuery getRequisiteQueryFromInspector(RequisiteQueryInspector requisiteQueryInspector)

Gets a requisite query from an inspector. The inspector is available from a RequisiteSearchResults .

Parameters:

requisiteQueryInspector - a requisite query inspector

Returns:

the requisite query

Throws:

NullArgumentException - requisiteQueryInspector is null

UnsupportedException - requisiteQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.