Interface | osid.control.rules.InputEnablerRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
Method | getSystemId | ||
Description |
Gets the | ||
Return | osid.id.Id | the System Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystem | ||
Description |
Gets the | ||
Return | osid.control.System | the system | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAssignInputEnablers | ||
Description |
Tests if this user can alter input enabler/input
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | assignInputEnablerToInput | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | inputEnablerId | the Id of the InputEnabler |
osid.id.Id | inputId | the Id of the Input | |
Errors | ALREADY_EXISTS | inputEnablerId already applied to inputId | |
NOT_FOUND | inputEnablerId or inputId not found | ||
NULL_ARGUMENT | inputEnablerId or inputId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignInputEnablerFromInput | ||
Description |
Removes an | ||
Parameters | osid.id.Id | inputEnablerId | the Id of the InputEnabler |
osid.id.Id | inputId | the Id of the Input | |
Errors | NOT_FOUND | inputEnablerId or inputId not found or not
mapped | |
NULL_ARGUMENT | inputEnablerId or inputId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceInputEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if InputEnabler ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveInputEnablerAhead | ||
Description |
Reorders input enablers for an input by moving the specified input enabler in front of a reference input enabler. | ||
Parameters | osid.id.Id | inputEnablerId | the Id of an InputEnabler |
osid.id.Id | inputId | the Id of an Input | |
osid.id.Id | referenceId | the reference input Id | |
Errors | NOT_FOUND | inputEnablerId, deviceProcesorId, or referenceId
not found or, inputEnablerId or referenceId
not related to inputId | |
NULL_ARGUMENT | inputEnablerId, inputId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveInputEnablerBehind | ||
Description |
Reorders input enablers for an input by moving the specified input enabler behind a reference input enabler. | ||
Parameters | osid.id.Id | inputEnablerId | the Id of an InputEnabler |
osid.id.Id | inputId | the Id of an Input | |
osid.id.Id | referenceId | the reference input Id | |
Errors | NOT_FOUND | inputEnablerId, deviceProcesorId, or referenceId
not found or, inputEnablerId or referenceId
not related to inputId | |
NULL_ARGUMENT | inputEnablerId, inputId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderInputEnablers | ||
Description |
Reorders a set of input enablers for an input. | ||
Parameters | osid.id.Id[] | inputEnablerIds | the Ids for a set of InputEnablers |
osid.id.Id | inputId | the Id of an Input | |
Errors | NOT_FOUND | inputId not found or, an inputEnablerId not
related to inputId | |
NULL_ARGUMENT | inputEnablerIds or inputId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |