public interface ActionGroupSystemSession extends OsidSession
This session provides methods to retrieve ActionGroup
to
System
mappings. An ActionGroup
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 |
canLookupActionGroupSystemMappings()
Tests if this user can perform lookups of action group/system
mappings.
|
IdList |
getActionGroupIdsBySystem(Id systemId)
Gets the list of
ActionGroup Ids associated with a
System. |
IdList |
getActionGroupIdsBySystems(IdList systemIds)
Gets the list of
ActionGroup Ids corresponding to a
list of Systems. |
ActionGroupList |
getActionGroupsBySystem(Id systemId)
Gets the list of
ActionGroups associated with a
System. |
ActionGroupList |
getActionGroupsBySystems(IdList systemIds)
Gets the list of
ActionGroup corresponding to a list of
Systems. |
IdList |
getSystemIdsByActionGroup(Id actionGroupId)
Gets the
System Ids mapped to an
ActionGroup. |
SystemList |
getSystemsByActionGroup(Id actionGroupId)
Gets the
Systems mapped to an ActionGroup. |
void |
useComparativeActionGroupSystemView()
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 |
usePlenaryActionGroupSystemView()
A complete view of the
ActionGroup and System
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupActionGroupSystemMappings()
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 useComparativeActionGroupSystemView()
mandatory
- This method is must be implemented. void usePlenaryActionGroupSystemView()
ActionGroup
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 getActionGroupIdsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActionGroup Ids
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. ActionGroupList getActionGroupsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActionGroups
associated with a
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 getActionGroupIdsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
ActionGroup 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. ActionGroupList getActionGroupsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
ActionGroup
corresponding to a list of
Systems.
systemIds
- list of system Ids
NullArgumentException
- systemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSystemIdsByActionGroup(Id actionGroupId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System
Ids
mapped to an
ActionGroup.
actionGroupId
- Id
of an ActionGroup
NotFoundException
- actionGroupId
is not
foundNullArgumentException
- actionGroupId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsByActionGroup(Id actionGroupId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Systems
mapped to an ActionGroup.
actionGroupId
- Id
of an ActionGroup
NotFoundException
- actionGroupId
is not
foundNullArgumentException
- actionGroupId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.