public interface TriggerEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve TriggerEnabler
to Trigger
mappings. A Device
with multiple
TriggerEnablers
means any positive rule evaluation across
the enablers result in an effective Device.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupTriggerEnablerRules()
Tests if this user can perform lookups of trigger enabler/trigger
mappings.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
IdList |
getTriggerEnablerIdsForTrigger(Id triggerId)
Gets the
TriggerEnabler Id associated with a
Trigger. |
TriggerEnablerList |
getTriggerEnablersForTrigger(Id triggerId)
Gets the
TriggerEnablers associated with a
Trigger. |
IdList |
getTriggerIdsForTriggerEnabler(Id triggerEnablerId)
Gets the
Trigger Ids mapped to a
TriggerEnabler. |
TriggerList |
getTriggersForTriggerEnabler(Id triggerEnablerId)
Gets the
Triggers mapped to a TriggerEnabler. |
void |
useComparativeTriggerEnablerRuleView()
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 |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
void |
usePlenaryTriggerEnablerRuleView()
A complete view of the
TriggerEnabler and
Trigger returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupTriggerEnablerRules()
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 useComparativeTriggerEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryTriggerEnablerRuleView()
TriggerEnabler
and
Trigger
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. void useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. IdList getTriggerEnablerIdsForTrigger(Id triggerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TriggerEnabler Id
associated with a
Trigger.
triggerId
- Id
of the Trigger
Ids
NotFoundException
- triggerId
is not
foundNullArgumentException
- triggerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerEnablerList getTriggerEnablersForTrigger(Id triggerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TriggerEnablers
associated with a
Trigger.
triggerId
- Id
of the Trigger
NotFoundException
- triggerId
is not
foundNullArgumentException
- triggerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getTriggerIdsForTriggerEnabler(Id triggerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Trigger
Ids
mapped to a
TriggerEnabler.
triggerEnablerId
- Id
of a TriggerEnabler
Ids
NotFoundException
- triggerEnablerId
is
not foundNullArgumentException
- triggerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerList getTriggersForTriggerEnabler(Id triggerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Triggers
mapped to a TriggerEnabler.
triggerEnablerId
- Id
of a TriggerEnabler
NotFoundException
- triggerEnablerId
is
not foundNullArgumentException
- triggerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.