Interface DocetSearchSession

All Superinterfaces:

AutoCloseable, Closeable, DocetQuerySession, OsidSession, OsidSession

public interface DocetSearchSession
extends DocetQuerySession

This session provides methods for searching Docets. The search query is constructed using the DocetQuery. The docet record Type also specifies the record for the docet query.

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

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

Method Summary

Modifier and Type	Method	Description
DocetQuery	getDocetQueryFromInspector(DocetQueryInspector docetQueryInspector)	Gets a docet query from an inspector.
DocetSearchResults	getDocetsBySearch(DocetQuery docetQuery, DocetSearch docetSearch)	Gets the search results matching the given search.
DocetSearch	getDocetSearch()	Gets a docet search.
DocetSearchOrder	getDocetSearchOrder()	Gets a docet search order.

Methods inherited from interface Closeable

close

Methods inherited from interface DocetQuerySession

canSearchDocets, getCourseCatalog, getCourseCatalogId, getDocetQuery, getDocetsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchDocets()	Tests if this user can perform Docet searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
DocetQuery	getDocetQuery()	Gets a docet query.
DocetList	getDocetsByQuery(DocetQuery docetQuery)	Gets a list of Docets matching the given search.
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

getDocetSearch

DocetSearch getDocetSearch()

Gets a docet search.

Returns:

the docet search

Compliance:

mandatory - This method must be implemented.

getDocetSearchOrder

DocetSearchOrder getDocetSearchOrder()

Gets a docet search order. The DocetSearchOrder is supplied to a DocetSearch to specify the ordering of results.

Returns:

the docet search order

Compliance:

mandatory - This method must be implemented.

getDocetsBySearch

DocetSearchResults getDocetsBySearch(DocetQuery docetQuery,
 DocetSearch docetSearch)
                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

docetQuery - the docet query

docetSearch - the docet search

Returns:

the docet search results

Throws:

NullArgumentException - docetQuery or docetSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - docetQuery or docetSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDocetQueryFromInspector

DocetQuery getDocetQueryFromInspector(DocetQueryInspector docetQueryInspector)

Gets a docet query from an inspector. The inspector is available from a DocetSearchResults.

Parameters:

docetQueryInspector - a docet query inspector

Returns:

the course catalog query

Throws:

NullArgumentException - docetQueryInspector is null

UnsupportedException - docetQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.