OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.InputEnablerRuleApplicationSession
Implementsosid.OsidSession
Description

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.

MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignInputEnablers
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignInputEnablerToInput
Description

Adds an existing InputEnabler to an Input.

Parametersosid.id.IdinputEnablerIdthe Id of the InputEnabler
osid.id.IdinputIdthe Id of the Input
ErrorsALREADY_EXISTS inputEnablerId already applied to inputId
NOT_FOUND inputEnablerId or inputId not found
NULL_ARGUMENT inputEnablerId or inputId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignInputEnablerFromInput
Description

Removes an InputEnabler from an Input.

Parametersosid.id.IdinputEnablerIdthe Id of the InputEnabler
osid.id.IdinputIdthe Id of the Input
ErrorsNOT_FOUND inputEnablerId or inputId not found or not mapped
NULL_ARGUMENT inputEnablerId or inputId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceInputEnablers
Description

Tests if this user can order 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.

Returnboolean false if InputEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveInputEnablerAhead
Description

Reorders input enablers for an input by moving the specified input enabler in front of a reference input enabler.

Parametersosid.id.IdinputEnablerIdthe Id of an InputEnabler
osid.id.IdinputIdthe Id of an Input
osid.id.IdreferenceIdthe reference input Id
ErrorsNOT_FOUND inputEnablerId, deviceProcesorId, or referenceId not found or, inputEnablerId or referenceId not related to inputId
NULL_ARGUMENT inputEnablerId, inputId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveInputEnablerBehind
Description

Reorders input enablers for an input by moving the specified input enabler behind a reference input enabler.

Parametersosid.id.IdinputEnablerIdthe Id of an InputEnabler
osid.id.IdinputIdthe Id of an Input
osid.id.IdreferenceIdthe reference input Id
ErrorsNOT_FOUND inputEnablerId, deviceProcesorId, or referenceId not found or, inputEnablerId or referenceId not related to inputId
NULL_ARGUMENT inputEnablerId, inputId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderInputEnablers
Description

Reorders a set of input enablers for an input.

Parametersosid.id.Id[]inputEnablerIdsthe Ids for a set of InputEnablers
osid.id.IdinputIdthe Id of an Input
ErrorsNOT_FOUND inputId not found or, an inputEnablerId not related to inputId
NULL_ARGUMENT inputEnablerIds or inputId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.