public interface InputEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply InputEnablers
to
Inputs.
An Input
with multiple
InputEnablers
means any positive rule evaluation across the
enablers result in an effective Input.
Modifier and Type | Method and Description |
---|---|
void |
assignInputEnablerToInput(Id inputEnablerId,
Id inputId)
Adds an existing
InputEnabler to an Input. |
boolean |
canAssignInputEnablers()
Tests if this user can alter input enabler/input mappings.
|
boolean |
canSequenceInputEnablers()
Tests if this user can order
Inputs. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
moveInputEnablerAhead(Id inputEnablerId,
Id inputId,
Id referenceId)
Reorders input enablers for an input by moving the specified input
enabler in front of a reference input enabler.
|
void |
moveInputEnablerBehind(Id inputEnablerId,
Id inputId,
Id referenceId)
Reorders input enablers for an input by moving the specified input
enabler behind a reference input enabler.
|
void |
orderInputEnablers(Id[] inputEnablerIds,
Id inputId)
Reorders a set of input enablers for an input.
|
void |
unassignInputEnablerFromInput(Id inputEnablerId,
Id inputId)
Removes an
InputEnabler from an Input. |
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 canAssignInputEnablers()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignInputEnablerToInput(Id inputEnablerId, Id inputId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
InputEnabler
to an Input.
inputEnablerId
- the Id
of the
InputEnabler
inputId
- the Id
of the Input
AlreadyExistsException
- inputEnablerId
already applied to inputId
NotFoundException
- inputEnablerId
or
inputId
not foundNullArgumentException
- inputEnablerId
or inputId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignInputEnablerFromInput(Id inputEnablerId, Id inputId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InputEnabler
from an Input.
inputEnablerId
- the Id
of the
InputEnabler
inputId
- the Id
of the Input
NotFoundException
- inputEnablerId
or
inputId
not found or not mappedNullArgumentException
- inputEnablerId
or inputId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceInputEnablers()
Inputs.
A return of true
does not guarantee successful authorization. A return of false
indicates that it is known sequencing operations will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer sequencing operations to an
unauthorized user. false
if InputEnabler
ordering
is not authorized, true
otherwisemandatory
- This method must be implemented. void moveInputEnablerAhead(Id inputEnablerId, Id inputId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
inputEnablerId
- the Id
of an InputEnabler
inputId
- the Id
of an Input
referenceId
- the reference input Id
NotFoundException
- inputEnablerId,
deviceProcesorId,
or referenceId
not
found or, inputEnablerId
or referenceId
not related to inputId
NullArgumentException
- inputEnablerId, inputId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveInputEnablerBehind(Id inputEnablerId, Id inputId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
inputEnablerId
- the Id
of an InputEnabler
inputId
- the Id
of an Input
referenceId
- the reference input Id
NotFoundException
- inputEnablerId,
deviceProcesorId,
or referenceId
not
found or, inputEnablerId
or referenceId
not related to inputId
NullArgumentException
- inputEnablerId, inputId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderInputEnablers(Id[] inputEnablerIds, Id inputId) throws NotFoundException, OperationFailedException, PermissionDeniedException
inputEnablerIds
- the Ids
for a set of
InputEnablers
inputId
- the Id
of an Input
NotFoundException
- inputId
not found
or, an inputEnablerId
not related to
inputId
NullArgumentException
- inputEnablerIds
or inputId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.