public interface InputSystemSession extends OsidSession
This session provides methods to retrieve Input
to
System
mappings. A Input
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 |
canLookupInputSystemMappings()
Tests if this user can perform lookups of input/system mappings.
|
IdList |
getInputIdsBySystem(Id systemId)
Gets the list of
Input Ids associated with a
System. |
IdList |
getInputIdsBySystems(IdList systemIds)
Gets the list of
Input Ids corresponding to a list of
Systems. |
InputList |
getInputsBySystem(Id systemId)
Gets the list of
Inputs associated with a
System. |
InputList |
getInputsBySystems(IdList systemIds)
Gets the list of
Input corresponding to a list of
Systems. |
IdList |
getSystemIdsByInput(Id inputId)
Gets the
System Ids mapped to a
Input. |
SystemList |
getSystemsByInput(Id inputId)
Gets the
Systems mapped to a Input. |
void |
useComparativeInputSystemView()
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 |
usePlenaryInputSystemView()
A complete view of the
Input and System
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupInputSystemMappings()
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 useComparativeInputSystemView()
mandatory
- This method is must be implemented. void usePlenaryInputSystemView()
Input
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 getInputIdsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Input 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. InputList getInputsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inputs
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 getInputIdsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
Input 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. InputList getInputsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
Input
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 getSystemIdsByInput(Id inputId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System
Ids
mapped to a
Input.
inputId
- Id
of a Input
NotFoundException
- inputId
is not foundNullArgumentException
- inputId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsByInput(Id inputId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Systems
mapped to a Input.
inputId
- Id
of a Input
NotFoundException
- inputId
is not foundNullArgumentException
- inputId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.