public interface ActionEnablerSystemSession extends OsidSession
This session provides methods to retrieve ActionEnabler
to System
mappings. An ActionEnabler
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 |
canLookupActionEnablerSystemMappings()
Tests if this user can perform lookups of action enabler/system
mappings.
|
IdList |
getActionEnablerIdsBySystem(Id systemId)
Gets the list of
ActionEnablerIds associated with a
System. |
IdList |
getActionEnablerIdsBySystems(IdList systemIds)
Gets the list of
ActionEnabler Ids corresponding to a
list of Systems. |
ActionEnablerList |
getActionEnablersBySystem(Id systemId)
Gets the list of action enablers associated with a
System. |
ActionEnablerList |
getActionEnablersBySystems(IdList systemIds)
Gets the list of action enablers corresponding to a list of
Systems. |
IdList |
getSystemIdsByActionEnabler(Id actionEnablerId)
Gets the
System Ids mapped to an
ActionEnabler. |
SystemList |
getSystemsByActionEnabler(Id actionEnablerId)
Gets the
Systems mapped to an ActionEnabler. |
void |
useComparativeActionEnablerSystemView()
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 |
usePlenaryActionEnablerSystemView()
A complete view of the
ActionEnabler and System
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupActionEnablerSystemMappings()
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 useComparativeActionEnablerSystemView()
mandatory
- This method is must be implemented. void usePlenaryActionEnablerSystemView()
ActionEnabler
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 getActionEnablerIdsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActionEnablerIds
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. ActionEnablerList getActionEnablersBySystem(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 getActionEnablerIdsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
ActionEnabler 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. ActionEnablerList getActionEnablersBySystems(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 getSystemIdsByActionEnabler(Id actionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System
Ids
mapped to an
ActionEnabler.
actionEnablerId
- Id
of an ActionEnabler
NotFoundException
- actionEnablerId
is
not foundNullArgumentException
- actionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsByActionEnabler(Id actionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Systems
mapped to an ActionEnabler.
actionEnablerId
- Id
of an ActionEnabler
NotFoundException
- actionEnablerId
is
not foundNullArgumentException
- actionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.