public interface RuleEngineSession extends OsidSession
This session provides methods to retrieve Rule
to
Engine
mappings. A Rule
may appear in multiple
Engine
objects. Each engine may have its own authorizations
governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRuleEngineMappings()
Tests if this user can perform lookups of rule/engine mappings.
|
IdList |
getEngineIdsByRule(Id ruleId)
Gets the
Engine Ids mapped to a
Rule. |
EngineList |
getEnginesByRule(Id ruleId)
Gets the
Engine objects mapped to a Rule. |
IdList |
getRuleIdsByEngine(Id engineId)
Gets the list of
Rule Ids associated with an
Engine. |
IdList |
getRuleIdsByEngines(IdList engineIds)
Gets the list of
Rule Ids corresponding to a list of
Engine objects. |
RuleList |
getRulesByEngine(Id engineId)
Gets the list of
Rules associated with an
Engine. |
RuleList |
getRulesByEngines(IdList engineIds)
Gets the list of
Rules corresponding to a list of
Engine objects. |
void |
useComparativeRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryRuleView()
A complete view of the
Rule returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRuleEngineMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeRuleView()
mandatory
- This method is must be implemented. void usePlenaryRuleView()
Rule
returns is desired. Methods
will return what is requested or result in an error. This view is used
when greater precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. IdList getRuleIdsByEngine(Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Rule Ids
associated with an
Engine.
engineId
- Id
of the Engine
Ids
NotFoundException
- engineId
is not
foundNullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RuleList getRulesByEngine(Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Rules
associated with an
Engine.
engineId
- Id
of the Engine
NotFoundException
- engineId
is not
foundNullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRuleIdsByEngines(IdList engineIds) throws OperationFailedException, PermissionDeniedException
Rule Ids
corresponding to a list of
Engine
objects.engineIds
- list of engine Ids
Ids
NullArgumentException
- engineIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RuleList getRulesByEngines(IdList engineIds) throws OperationFailedException, PermissionDeniedException
Rules
corresponding to a list of
Engine
objects.engineIds
- list of engine Ids
NullArgumentException
- engineIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getEngineIdsByRule(Id ruleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Engine
Ids
mapped to a
Rule.
ruleId
- Id
of a Rule
NotFoundException
- ruleId
is not foundNullArgumentException
- ruleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EngineList getEnginesByRule(Id ruleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Engine
objects mapped to a Rule.
ruleId
- Id
of a Rule
NotFoundException
- ruleId
is not foundNullArgumentException
- ruleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.