public interface ControllerSystemSession extends OsidSession
This session provides methods to retrieve Controller
to
System
mappings. A Controller
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 |
canLookupControllerSystemMappings()
Tests if this user can perform lookups of controller/system mappings.
|
IdList |
getControllerIdsBySystem(Id systemId)
Gets the list of
Controller Ids associated with a
System. |
IdList |
getControllerIdsBySystems(IdList systemIds)
Gets the list of
Controller Ids corresponding to a list
of Systems. |
ControllerList |
getControllersBySystem(Id systemId)
Gets the list of controllers associated with a
System. |
ControllerList |
getControllersBySystems(IdList systemIds)
Gets the list of controllers corresponding to a list of
Systems. |
IdList |
getSystemIdsByController(Id controllerId)
Gets the
System Ids mapped to a
Controller. |
SystemList |
getSystemsByController(Id controllerId)
Gets the
Systems mapped to a Controller. |
void |
useComparativeControllerSystemView()
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 |
usePlenaryControllerSystemView()
A complete view of the
Controller and System
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupControllerSystemMappings()
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 useComparativeControllerSystemView()
mandatory
- This method is must be implemented. void usePlenaryControllerSystemView()
Controller
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 getControllerIdsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Controller 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. ControllerList getControllersBySystem(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 getControllerIdsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
Controller 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. ControllerList getControllersBySystems(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 getSystemIdsByController(Id controllerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System
Ids
mapped to a
Controller.
controllerId
- Id
of a Controller
NotFoundException
- controllerId
is not
foundNullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsByController(Id controllerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Systems
mapped to a Controller.
controllerId
- Id
of a Controller
NotFoundException
- controllerId
is not
foundNullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.