public interface RuleSearchSession extends RuleQuerySession
This session provides methods for searching Rule
objects. The search query is constructed using the RuleQuery.
The rule record Type
also specifies the record for
the rule query.
getRulesByQuery()
is the basic search method and
returns a list of Rule
elements. A more advanced search may
be performed with getRulesBySearch().
It accepts a
RuleSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getRulesBySearch()
returns a RuleSearchResults
that
can be used to access the resulting RuleList
or be used to
perform a search within the result set through RuleSearch.
Rules may have a query record indicated by their respective record
types. The rule query record is accessed via the RuleQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
RuleQuery |
getRuleQueryFromInspector(RuleQueryInspector ruleQueryInspector)
Gets a rule query from an inspector.
|
RuleSearchResults |
getRulesBySearch(RuleQuery ruleQuery,
RuleSearch ruleSearch)
Gets the search results matching the given search.
|
RuleSearch |
getRuleSearch()
Gets a rule search.
|
RuleSearchOrder |
getRuleSearchOrder()
Gets a rule search order.
|
canSearchRules, getEngine, getEngineId, getRuleQuery, getRulesByQuery, useFederatedEngineView, useIsolatedEngineView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RuleSearch getRuleSearch()
mandatory
- This method must be implemented. RuleSearchOrder getRuleSearchOrder()
RuleSearchOrder
is
supplied to a RuleSearch
to specify the ordering of
results.mandatory
- This method must be implemented. RuleSearchResults getRulesBySearch(RuleQuery ruleQuery, RuleSearch ruleSearch) throws OperationFailedException, PermissionDeniedException
ruleQuery
- the rule queryruleSearch
- the rule searchNullArgumentException
- ruleQuery
or
ruleSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- ruleQuery
or
ruleSearch
is not of this servicemandatory
- This method must be implemented. RuleQuery getRuleQueryFromInspector(RuleQueryInspector ruleQueryInspector)
RuleSearchResults.
ruleQueryInspector
- a rule query inspectorNullArgumentException
- ruleQueryInspector
is null
UnsupportedException
- ruleQueryInspector
is not of this servicemandatory
- This method must be implemented.