Interface ModuleSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ModuleQuerySession, OsidSession, OsidSession

public interface ModuleSearchSession
extends ModuleQuerySession

This session provides methods for searching Modules. The search query is constructed using the ModuleQuery. The module record Type also specifies the record for the module query.

getModulesByQuery() is the basic search method and returns a list of CourseCatalog elements. A more advanced search may be performed with getModulesBySearch(). It accepts a ModuleSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getModulesBySearch() returns a ModuleSearchResults that can be used to access the resulting ModuleList or be used to perform a search within the result set through ModuleSearch.

Modules may have a query record indicated by their respective record types. The query record is accessed via the ModuleQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
ModuleQuery	getModuleQueryFromInspector(ModuleQueryInspector moduleQueryInspector)	Gets a module query from an inspector.
ModuleSearchResults	getModulesBySearch(ModuleQuery moduleQuery, ModuleSearch moduleSearch)	Gets the search results matching the given search.
ModuleSearch	getModuleSearch()	Gets a module search.
ModuleSearchOrder	getModuleSearchOrder()	Gets a module search order.

Methods inherited from interface Closeable

close

Methods inherited from interface ModuleQuerySession

canSearchModules, getCourseCatalog, getCourseCatalogId, getModuleQuery, getModulesByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchModules()	Tests if this user can perform susbcription searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
ModuleQuery	getModuleQuery()	Gets a module query.
ModuleList	getModulesByQuery(ModuleQuery moduleQuery)	Gets a list of modules matching the given module 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

getModuleSearch

ModuleSearch getModuleSearch()

Gets a module search.

Returns:

the module search

Compliance:

mandatory - This method must be implemented.

getModuleSearchOrder

ModuleSearchOrder getModuleSearchOrder()

Gets a module search order. The ModuleSearchOrder is supplied to a ModuleSearch to specify the ordering of results.

Returns:

the module search order interface

Compliance:

mandatory - This method must be implemented.

getModulesBySearch

ModuleSearchResults getModulesBySearch(ModuleQuery moduleQuery,
 ModuleSearch moduleSearch)
                                throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

moduleQuery - the module query

moduleSearch - the module search

Returns:

the module search results

Throws:

NullArgumentException - moduleQuery or moduleSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - moduleQuery or moduleSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getModuleQueryFromInspector

ModuleQuery getModuleQueryFromInspector(ModuleQueryInspector moduleQueryInspector)

Gets a module query from an inspector. The inspector is available from a ModuleSearchResults.

Parameters:

moduleQueryInspector - a module query inspector

Returns:

the module query

Throws:

NullArgumentException - moduleQueryInspector is null

UnsupportedException - moduleQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.