public interface CommissionEnablerSearchSession extends CommissionEnablerQuerySession
This session provides methods for searching among
CommissionEnabler
objects. The search query is constructed using
the CommissionEnableryQuery.
getCommissionEnablersByQuery()
is the basic search
method and returns a list of CommissionEnablers.
A more
advanced search may be performed with
getCommissionEnablersBySearch().
It accepts a
CommissionEnablerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
resourcing. getCommissionEnablersBySearch()
returns a
CommissionEnablerSearchResults
that can be used to access
the resulting CommissionEnablerList
or be used to perform a
search within the result set through CommissionEnablerSearch.
This session defines views that offer differing behaviors for searching.
CommissionEnablers
may have a commission enabler query
record indicated by their respective record types. The commission enabler
query record is accessed via the CommissionEnablerQuery.
Modifier and Type | Method and Description |
---|---|
CommissionEnablerQuery |
getCommissionEnablerQueryFromInspector(CommissionEnablerQueryInspector ccommissionEnablerQueryInspector)
Gets a commission enabler query from an inspector.
|
CommissionEnablerSearchResults |
getCommissionEnablersBySearch(CommissionEnablerQuery commissionEnablerQuery,
CommissionEnablerSearch commissionEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
CommissionEnablerSearch |
getCommissionEnablerSearch()
Gets a commission enabler search.
|
CommissionEnablerSearchOrder |
getCommissionEnablerSearchOrder()
Gets a commission enabler search order.
|
canSearchCommissionEnablers, getCommissionEnablerQuery, getCommissionEnablersByQuery, getFoundry, getFoundryId, useFederatedFoundryView, useIsolatedFoundryView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CommissionEnablerSearch getCommissionEnablerSearch()
mandatory
- This method must be implemented. CommissionEnablerSearchOrder getCommissionEnablerSearchOrder()
CommissionEnablerSearchOrder
is supplied to a
CommissionEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. CommissionEnablerSearchResults getCommissionEnablersBySearch(CommissionEnablerQuery commissionEnablerQuery, CommissionEnablerSearch commissionEnablerSearch) throws OperationFailedException, PermissionDeniedException
commissionEnablerQuery
- the commission enabler querycommissionEnablerSearch
- the commission enabler searchNullArgumentException
- commissionEnablerQuery
or commissionEnablerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- commissionEnablerQuery
or commissionEnablerSearch
is not of
this servicemandatory
- This method must be implemented. CommissionEnablerQuery getCommissionEnablerQueryFromInspector(CommissionEnablerQueryInspector ccommissionEnablerQueryInspector)
CommissionEnablerSearchResults.
ccommissionEnablerQueryInspector
- a commission enabler query
inspectorNullArgumentException
-
commissionEnablerQueryInspector
is null
UnsupportedException
-
commissionEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.