OSID Logo
OSID Specifications
control rules package
Version 3.1.0
Interfaceosid.control.rules.InputEnablerSystemAssignmentSession
Implementsosid.OsidSession
Used Byosid.control.rules.ControlRulesManager
osid.control.rules.ControlRulesProxyManager
Description

This session provides methods to re-assign InputEnabler to System mappings. An InputEnabler may appear in multiple System objects and removing the last reference to an InputEnabler is the equivalent of deleting it. Each System may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an InputEnabler to another System is not a copy operation (eg: does not change its Id).

MethodcanAssignInputEnablers
Description

Tests if this user can alter input enabler/system 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
Compliancemandatory This method must be implemented.
MethodcanAssignInputEnablersToSystem
Description

Tests if this user can alter input enabler/system 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.

Parametersosid.id.IdsystemId the Id of the System
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT systemId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableSystemIds
Description

Gets a list of systems including and under the given system node in which any input enabler can be assigned.

Parametersosid.id.IdsystemId the Id of the Syestem
Returnosid.id.IdList list of assignable system Ids
ErrorsNULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableSystemIdsForInputEnabler
Description

Gets a list of systems including and under the given system node in which a specific input enabler can be assigned.

Parametersosid.id.IdsystemId the Id of the System
osid.id.IdinputEnablerId the Id of the InputEnabler
Returnosid.id.IdList list of assignable system Ids
ErrorsNULL_ARGUMENT systemId or inputEnablerId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignInputEnablerToSystem
Description

Adds an existing InputEnabler to a System.

Parametersosid.id.IdinputEnablerId the Id of the InputEnabler
osid.id.IdsystemId the Id of the System
ErrorsALREADY_EXISTS inputEnablerId already assigned to systemId
NOT_FOUND inputEnablerId or systemId not found
NULL_ARGUMENT inputEnablerId or systemId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignInputEnablerFromSystem
Description

Removes an InputEnabler from a System.

Parametersosid.id.IdinputEnablerId the Id of the InputEnabler
osid.id.IdsystemId the Id of the System
ErrorsNOT_FOUND inputEnablerId or systemId not found or inputEnablerId not assigned to systemId
NULL_ARGUMENT inputEnablerId or systemId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignInputEnablerToSystem
Description

Moves an InputEnabler from one System to another. Mappings to other Systems are unaffected.

Parametersosid.id.IdinputEnablerId the Id of the InputEnabler
osid.id.IdfromSystemId the Id of the current System
osid.id.IdtoSystemId the Id of the destination System
ErrorsALREADY_EXISTS inputEnablerId already assigned to toSystemId
NOT_FOUND inputEnablerId, fromSystemId, or toSystemId not found or inputEnablerId not mapped to fromSystemId
NULL_ARGUMENT inputEnablerId, fromSystemId, or toSystemId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.