public interface TriggerEnablerSystemSession extends OsidSession
This session provides methods to retrieve TriggerEnabler
to System
mappings. A TriggerEnabler
may
appear in multiple System
objects. Each system 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 |
canLookupTriggerEnablerSystemMappings()
Tests if this user can perform lookups of trigger enabler/system
mappings.
|
IdList |
getSystemIdsByTriggerEnabler(Id triggerEnablerId)
Gets the
System Ids mapped to a
TriggerEnabler. |
SystemList |
getSystemsByTriggerEnabler(Id triggerEnablerId)
Gets the
Systems mapped to a TriggerEnabler. |
IdList |
getTriggerEnablerIdsBySystem(Id systemId)
Gets the list of
TriggerEnablerIds associated with a
System. |
IdList |
getTriggerEnablerIdsBySystems(IdList systemIds)
Gets the list of
TriggerEnabler Ids corresponding to a
list of Systems. |
TriggerEnablerList |
getTriggerEnablersBySystem(Id systemId)
Gets the list of trigger enablers associated with a
System. |
TriggerEnablerList |
getTriggerEnablersBySystems(IdList systemIds)
Gets the list of trigger enablers corresponding to a list of
Systems |
void |
useComparativeTriggerEnablerSystemView()
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 |
usePlenaryTriggerEnablerSystemView()
A complete view of the
TriggerEnabler and System
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupTriggerEnablerSystemMappings()
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 useComparativeTriggerEnablerSystemView()
mandatory
- This method is must be implemented. void usePlenaryTriggerEnablerSystemView()
TriggerEnabler
and System
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 getTriggerEnablerIdsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TriggerEnablerIds
associated with a
System.
systemId
- Id
of the System
Ids
NotFoundException
- systemId
is not
foundNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerEnablerList getTriggerEnablersBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System.
systemId
- Id
of the System
NotFoundException
- systemId
is not
foundNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getTriggerEnablerIdsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
TriggerEnabler Ids
corresponding to a
list of Systems.
systemIds
- list of system Ids
Ids
NullArgumentException
- systemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. TriggerEnablerList getTriggerEnablersBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
Systems
systemIds
- list of system Ids
NullArgumentException
- systemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSystemIdsByTriggerEnabler(Id triggerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System
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. SystemList getSystemsByTriggerEnabler(Id triggerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Systems
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.