org.osid.cataloging

Interface CatalogSearchSession

All Superinterfaces:

java.lang.AutoCloseable, CatalogQuerySession, java.io.Closeable, OsidSession

public interface CatalogSearchSession
extends CatalogQuerySession

This session provides methods for searching Catalog objects. The search query is constructed using the CatalogQuery . The catalog record Type also specifies the record for the catalog query.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
CatalogQuery	getCatalogQueryFromInspector(CatalogQueryInspector catalogQueryInspector) Gets a catalog query from an inspector.
CatalogSearchResults	getCatalogsBySearch(CatalogQuery catalogQuery, CatalogSearch catalogSearch) Gets the search results matching the given search.
CatalogSearch	getCatalogSearch() Gets a catalog search.
CatalogSearchOrder	getCatalogSearchOrder() Gets a subject search order.

Methods inherited from interface org.osid.cataloging.CatalogQuerySession

canSearchCatalogs, getCatalogQuery, getCatalogsByQuery

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

getCatalogSearch

CatalogSearch getCatalogSearch()

Gets a catalog search.

Returns:

the catalog search

Compliance:

mandatory - This method must be implemented.

getCatalogSearchOrder

CatalogSearchOrder getCatalogSearchOrder()

Gets a subject search order. The CatalogSearchOrder is supplied to a CatalogSearch to specify the ordering of results.

Returns:

the catalog search order

Compliance:

mandatory - This method must be implemented.

getCatalogsBySearch

CatalogSearchResults getCatalogsBySearch(CatalogQuery catalogQuery,
                                       CatalogSearch catalogSearch)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets the search results matching the given search.

Parameters:

catalogQuery - the catalog query

catalogSearch - the catalog search

Returns:

the search results

Throws:

NullArgumentException - catalogQuery or catalogSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - catalogQuery or catalogSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCatalogQueryFromInspector

CatalogQuery getCatalogQueryFromInspector(CatalogQueryInspector catalogQueryInspector)

Gets a catalog query from an inspector. The inspector is available from an CatalogSearchResults.

Parameters:

catalogQueryInspector - a catalog query inspector

Returns:

the catalog query

Throws:

NullArgumentException - catalogQueryInspector is null

UnsupportedException - catalogQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.