Interface CatalogueSearchSession

All Superinterfaces:

AutoCloseable, CatalogueQuerySession, Closeable, OsidSession, OsidSession

public interface CatalogueSearchSession
extends CatalogueQuerySession

This session provides methods for searching Catalogues. The search query is constructed using the CatalogueQuery. The catalogue record Type also specifies the catalogue query record for the catalogue query.

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

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

Method Summary

Modifier and Type	Method	Description
CatalogueQuery	getCatalogueQueryFromInspector(CatalogueQueryInspector catalogueQueryInspector)	Gets a catalogue query from an inspector.
CatalogueSearchResults	getCataloguesBySearch(CatalogueQuery catalogueQuery, CatalogueSearch catalogueSearch)	Gets the search results matching the given search.
CatalogueSearch	getCatalogueSearch()	Gets a catalogue search.
CatalogueSearchOrder	getCatalogueSearchOrder()	Gets a catalogue search order.

Methods inherited from interface CatalogueQuerySession

canSearchCatalogues, getCatalogueQuery, getCataloguesByQuery

Modifier and Type	Method	Description
boolean	canSearchCatalogues()	Tests if this user can perform Catalogue searches.
CatalogueQuery	getCatalogueQuery()	Gets a catalogue query.
CatalogueList	getCataloguesByQuery(CatalogueQuery catalogueQuery)	Gets a list of Catalogues matching the given search.

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.

Method Details

getCatalogueSearch

CatalogueSearch getCatalogueSearch()

Gets a catalogue search.

Returns:

the catalogue search

Compliance:

mandatory - This method must be implemented.

getCatalogueSearchOrder

CatalogueSearchOrder getCatalogueSearchOrder()

Gets a catalogue search order. The CatalogueSearchOrder is supplied to a CatalogueSearch to specify the ordering of results.

Returns:

the catalogue search order

Compliance:

mandatory - This method must be implemented.

getCataloguesBySearch

CatalogueSearchResults getCataloguesBySearch(CatalogueQuery catalogueQuery,
 CatalogueSearch catalogueSearch)
                                      throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

catalogueQuery - the catalogue query

catalogueSearch - the catalogue search

Returns:

the search results

Throws:

NullArgumentException - catalogueQuery or catalogueSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - catalogueQuery or catalogueSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCatalogueQueryFromInspector

CatalogueQuery getCatalogueQueryFromInspector(CatalogueQueryInspector catalogueQueryInspector)

Gets a catalogue query from an inspector. The inspector is available from a CatalogueSearchResults.

Parameters:

catalogueQueryInspector - a catalogue query inspector

Returns:

the catalogue query

Throws:

NullArgumentException - catalogueQueryInspector is null

UnsupportedException - icatalogueQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.