Interface CatalogEnablerSearchSession

All Superinterfaces:

AutoCloseable, CatalogEnablerQuerySession, Closeable, OsidSession, OsidSession

public interface CatalogEnablerSearchSession
extends CatalogEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
CatalogEnablerQuery	getCatalogEnablerQueryFromInspector(CatalogEnablerQueryInspector catalogEnablerQueryInspector)	Gets a catalog enabler query from an inspector.
CatalogEnablerSearchResults	getCatalogEnablersBySearch(CatalogEnablerQuery catalogEnablerQuery, CatalogEnablerSearch catalogEnablerSearch)	Gets the search results matching the given search query using the given search.
CatalogEnablerSearch	getCatalogEnablerSearch()	Gets a catalog enabler search.
CatalogEnablerSearchOrder	getCatalogEnablerSearchOrder()	Gets a catalog enabler search order.

Methods inherited from interface CatalogEnablerQuerySession

canSearchCatalogEnablers, getCatalog, getCatalogEnablerQuery, getCatalogEnablersByQuery, getCatalogId, useFederatedCatalogView, useIsolatedCatalogView

Modifier and Type	Method	Description
boolean	canSearchCatalogEnablers()	Tests if this user can perform CatalogEnabler lookups.
Catalog	getCatalog()	Gets the Catalog associated with this session.
CatalogEnablerQuery	getCatalogEnablerQuery()	Gets a catalog enabler query.
CatalogEnablerList	getCatalogEnablersByQuery(CatalogEnablerQuery catalogEnablerQuery)	Gets a list of CatalogEnablers matching the given search.
Id	getCatalogId()	Gets the Catalog Id associated with this session.
void	useFederatedCatalogView()	Federates the view for methods in this session.
void	useIsolatedCatalogView()	Isolates the view for methods in this session.

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

getCatalogEnablerSearch

CatalogEnablerSearch getCatalogEnablerSearch()

Gets a catalog enabler search.

Returns:

the catalog enabler search

Compliance:

mandatory - This method must be implemented.

getCatalogEnablerSearchOrder

CatalogEnablerSearchOrder getCatalogEnablerSearchOrder()

Gets a catalog enabler search order. The CatalogEnablerSearchOrder is supplied to a CatalogEnablerSearch to specify the ordering of results.

Returns:

the catalog enabler search order

Compliance:

mandatory - This method must be implemented.

getCatalogEnablersBySearch

CatalogEnablerSearchResults getCatalogEnablersBySearch(CatalogEnablerQuery catalogEnablerQuery,
 CatalogEnablerSearch catalogEnablerSearch)
                                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

catalogEnablerQuery - the catalog enabler query

catalogEnablerSearch - the catalog enabler search

Returns:

the returned search results

Throws:

NullArgumentException - catalogEnablerQuery or catalogEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - catalogEnablerQuery or catalogEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCatalogEnablerQueryFromInspector

CatalogEnablerQuery getCatalogEnablerQueryFromInspector(CatalogEnablerQueryInspector catalogEnablerQueryInspector)

Gets a catalog enabler query from an inspector. The inspector is available from a CatalogEnablerSearchResults.

Parameters:

catalogEnablerQueryInspector - a catalog enabler query inspector

Returns:

the catalog enabler query

Throws:

NullArgumentException - catalogEnablerQueryInspector is null

UnsupportedException - catalogEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.