public interface InputEnablerSystemSession extends OsidSession
This session provides methods to retrieve InputEnabler
to System
mappings. An InputEnabler
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 |
canLookupInputEnablerSystemMappings()
Tests if this user can perform lookups of input enabler/system
mappings.
|
IdList |
getInputEnablerIdsBySystem(Id systemId)
Gets the list of
InputEnablerIds associated with a
System. |
IdList |
getInputEnablerIdsBySystems(IdList systemIds)
Gets the list of
InputEnabler Ids corresponding to a
list of Systems. |
InputEnablerList |
getInputEnablersBySystem(Id systemId)
Gets the list of input enablers associated with a
System. |
InputEnablerList |
getInputEnablersBySystems(IdList systemIds)
Gets the list of input enablers corresponding to a list of
Systems. |
IdList |
getSystemIdsByInputEnabler(Id inputEnablerId)
Gets the
System Ids mapped to an
InputEnabler. |
SystemList |
getSystemsByInputEnabler(Id inputEnablerId)
Gets the
Systems mapped to an InputEnabler. |
void |
useComparativeInputEnablerSystemView()
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 |
usePlenaryInputEnablerSystemView()
A complete view of the
InputEnabler and System
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupInputEnablerSystemMappings()
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 useComparativeInputEnablerSystemView()
mandatory
- This method is must be implemented. void usePlenaryInputEnablerSystemView()
InputEnabler
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 getInputEnablerIdsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InputEnablerIds
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. InputEnablerList getInputEnablersBySystem(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 getInputEnablerIdsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
InputEnabler 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. InputEnablerList getInputEnablersBySystems(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 getSystemIdsByInputEnabler(Id inputEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System
Ids
mapped to an
InputEnabler.
inputEnablerId
- Id
of an InputEnabler
Ids
NotFoundException
- inputEnablerId
is
not foundNullArgumentException
- inputEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsByInputEnabler(Id inputEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Systems
mapped to an InputEnabler.
inputEnablerId
- Id
of an InputEnabler
NotFoundException
- inputEnablerId
is
not foundNullArgumentException
- inputEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.