public interface InputEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve InputEnabler
to Input
mappings. An Input
with multiple
InputEnablers
means any positive rule evaluation across the
enablers result in an effective Input.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupInputEnablerRules()
Tests if this user can perform lookups of input enabler/input
mappings.
|
IdList |
getInputEnablerIdsForInput(Id inputId)
Gets the
InputEnabler Id associated with an
Input. |
InputEnablerList |
getInputEnablersForInput(Id inputId)
Gets the
InputEnabler associated with an Input. |
IdList |
getInputIdsForInputEnabler(Id inputEnablerId)
Gets the
Input Ids mapped to an
InputEnabler. |
InputList |
getInputsForInputEnabler(Id inputEnablerId)
Gets the
Inputs mapped to an InputEnabler. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useComparativeInputEnablerRuleView()
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 |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
void |
usePlenaryInputEnablerRuleView()
A complete view of the
InputEnabler and Input
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupInputEnablerRules()
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 useComparativeInputEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryInputEnablerRuleView()
InputEnabler
and Input
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. void useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. IdList getInputEnablerIdsForInput(Id inputId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InputEnabler Id
associated with an
Input.
inputId
- Id
of the Input
Ids
NotFoundException
- inputId
is not foundNullArgumentException
- inputId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputEnablerList getInputEnablersForInput(Id inputId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InputEnabler
associated with an Input.
inputId
- Id
of the Input
NotFoundException
- inputId
is not foundNullArgumentException
- inputId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getInputIdsForInputEnabler(Id inputEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Input
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. InputList getInputsForInputEnabler(Id inputEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inputs
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.