public interface StoreSearchSession extends StoreQuerySession
This session provides methods for searching Store
objects. The search query is constructed using the StoreQuery.
The store record Type
also specifies the record for
the store query.
getStoresByQuery()
is the basic search method and
returns a list of Store
elements. A more advanced search
may be performed with getStoresBySearch().
It accepts a
StoreSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getStoresBySearch()
returns a
StoreSearchResults
that can be used to access the resulting
StoreList
or be used to perform a search within the result set
through StoreSearch.
Stores may have a query record indicated by their respective record
types. The query record is accessed via the StoreQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
StoreQuery |
getStoreQueryFromInspector(StoreQueryInspector storeQueryInspector)
Gets an entry query from an inspector.
|
StoreSearchResults |
getStoresBySearch(StoreQuery storeQuery,
StoreSearch storeSearch)
Gets the search results matching the given search.
|
StoreSearch |
getStoreSearch()
Gets a store search.
|
StoreSearchOrder |
getStoreSearchOrder()
Gets a store search order.
|
canSearchStores, getStoreQuery, getStoresByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
StoreSearch getStoreSearch()
mandatory
- This method must be implemented. StoreSearchOrder getStoreSearchOrder()
StoreSearchOrder
is
supplied to a StoreSearch
to specify the ordering of
results.mandatory
- This method must be implemented. StoreSearchResults getStoresBySearch(StoreQuery storeQuery, StoreSearch storeSearch) throws OperationFailedException, PermissionDeniedException
storeQuery
- the store querystoreSearch
- the store searchNullArgumentException
- storeQuery
or
storeSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- storeQuery
or
storeSearch
is not of this servicemandatory
- This method must be implemented. StoreQuery getStoreQueryFromInspector(StoreQueryInspector storeQueryInspector)
StoreSearchResults.
storeQueryInspector
- a query inspectorNullArgumentException
- storeQueryInspector
is null
UnsupportedException
- storeQueryInspector
is not of this servicemandatory
- This method must be implemented.