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.
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.
|
canSearchCatalogs, getCatalogQuery, getCatalogsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CatalogSearch getCatalogSearch()
mandatory
- This method must be implemented. CatalogSearchOrder getCatalogSearchOrder()
CatalogSearchOrder
is
supplied to a CatalogSearch
to specify the ordering of
results.mandatory
- This method must be implemented. CatalogSearchResults getCatalogsBySearch(CatalogQuery catalogQuery, CatalogSearch catalogSearch) throws OperationFailedException, PermissionDeniedException
catalogQuery
- the catalog querycatalogSearch
- the catalog searchNullArgumentException
- catalogQuery
or
catalogSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- catalogQuery
or
catalogSearch
is not of this servicemandatory
- This method must be implemented. CatalogQuery getCatalogQueryFromInspector(CatalogQueryInspector catalogQueryInspector)
CatalogSearchResults.
catalogQueryInspector
- a catalog query inspectorNullArgumentException
- catalogQueryInspector
is null
UnsupportedException
- catalogQueryInspector
is not of this servicemandatory
- This method must be implemented.