public interface RuleQuerySession extends OsidSession
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.
Rules may have a rule 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 |
---|---|
boolean |
canSearchRules()
Tests if this user can perform
Rule searches. |
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
RuleQuery |
getRuleQuery()
Gets a rule query.
|
RuleList |
getRulesByQuery(RuleQuery ruleQuery)
Gets a list of
Rules matching the given rule query. |
void |
useFederatedEngineView()
Federates the view for methods in this session.
|
void |
useIsolatedEngineView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getEngineId()
Engine
Id
associated with this
session. Engine Id
associated with this sessionmandatory
- This method must be implemented. Engine getEngine() throws OperationFailedException, PermissionDeniedException
Engine
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void useFederatedEngineView()
mandatory
- This method is must be implemented. void useIsolatedEngineView()
mandatory
- This method is must be implemented. boolean canSearchRules()
Rule
searches. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. RuleQuery getRuleQuery()
mandatory
- This method must be implemented. RuleList getRulesByQuery(RuleQuery ruleQuery) throws OperationFailedException, PermissionDeniedException
Rules
matching the given rule query.ruleQuery
- the rule query RuleList
NullArgumentException
- ruleQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- ruleQuery
is not
of this servicemandatory
- This method must be implemented.