org.osid.cataloging.rules

Interface CatalogEnablerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, CatalogEnablerQuerySession, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.cataloging.rules.CatalogEnablerQuerySession

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

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.