public interface CatalogueSearchSession extends CatalogueQuerySession
This session provides methods for searching Catalogue
objects. 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.
Modifier and Type | Method and 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.
|
canSearchCatalogues, getCatalogueQuery, getCataloguesByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CatalogueSearch getCatalogueSearch()
mandatory
- This method must be implemented. CatalogueSearchOrder getCatalogueSearchOrder()
CatalogueSearchOrder
is supplied to a CatalogueSearch
to specify the
ordering of results.mandatory
- This method must be implemented. CatalogueSearchResults getCataloguesBySearch(CatalogueQuery catalogueQuery, CatalogueSearch catalogueSearch) throws OperationFailedException, PermissionDeniedException
catalogueQuery
- the catalogue querycatalogueSearch
- the catalogue searchNullArgumentException
- catalogueQuery
or catalogueSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- catalogueQuery
or
catalogueSearch
is not of this servicemandatory
- This method must be implemented. CatalogueQuery getCatalogueQueryFromInspector(CatalogueQueryInspector catalogueQueryInspector)
CatalogueSearchResults.
catalogueQueryInspector
- a catalogue query inspectorNullArgumentException
- catalogueQueryInspector
is null
UnsupportedException
- icatalogueQueryInspector
is not of this servicemandatory
- This method must be implemented.