public interface DistributorSearchSession extends DistributorQuerySession
This session provides methods for searching among Distributor
objects. The search query is constructed using the
DistributorQuery.
getDistributorsByQuery()
is the basic search method and
returns a list of Distributors.
A more advanced search may
be performed with getDistributorsBySearch().
It accepts a
DistributorSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getDistributorsBySearch()
returns a
DistributorSearchResults
that can be used to access the resulting
DistributorList
or be used to perform a search within the
result set through DistributorSearch.
Distributors may have a query record indicated by their respective
record types. The query record is accessed via the
DistributorQuery.
Modifier and Type | Method and Description |
---|---|
DistributorQuery |
getDistributorQueryFromInspector(DistributorQueryInspector distributorQueryInspector)
Gets a distributor query from an inspector.
|
DistributorSearchResults |
getDistributorsBySearch(DistributorQuery distributorQuery,
DistributorSearch distributorSearch)
Gets the search results matching the given search query using the
given search.
|
DistributorSearch |
getDistributorSearch()
Gets a distributor search.
|
DistributorSearchOrder |
getDistributorSearchOrder()
Gets a distributor search order.
|
canSearchDistributors, getDistributorQuery, getDistributorsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DistributorSearch getDistributorSearch()
mandatory
- This method must be implemented. DistributorSearchOrder getDistributorSearchOrder()
DistributorSearchOrder
is supplied to a DistributorSearch
to specify
the ordering of results.mandatory
- This method must be implemented. DistributorSearchResults getDistributorsBySearch(DistributorQuery distributorQuery, DistributorSearch distributorSearch) throws OperationFailedException, PermissionDeniedException
distributorQuery
- the distributor querydistributorSearch
- the distributor searchNullArgumentException
- distributorQuery
or distributorSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- distributorQuery
or distributorSearch
is not of this servicemandatory
- This method must be implemented. DistributorQuery getDistributorQueryFromInspector(DistributorQueryInspector distributorQueryInspector)
DistributorSearchResults.
distributorQueryInspector
- a distributor query inspectorNullArgumentException
-
distributorQueryInspector
is null
UnsupportedException
- distributorQueryInspector
is not of this servicemandatory
- This method must be implemented.