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

This session provides methods to apply DeviceEnablers to Devices. A Device with multiple DeviceEnablers means any positive rule evaluation across the enablers result in an active Device.

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.
MethodcanAssignDeviceEnablers
Description

Tests if this user can alter device enabler/device 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.
MethodassignDeviceEnablerToDevice
Description

Adds an existing DeviceEnabler to a Device.

Parametersosid.id.IddeviceEnablerIdthe Id of the DeviceEnabler
osid.id.IddeviceIdthe Id of the Device
ErrorsALREADY_EXISTS deviceEnablerId already applied to deviceId
NOT_FOUND deviceEnablerId or deviceId not found
NULL_ARGUMENT deviceEnablerId or deviceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignDeviceEnablerFromDevice
Description

Removes a DeviceEnabler from a Device.

Parametersosid.id.IddeviceEnablerIdthe Id of the DeviceEnabler
osid.id.IddeviceIdthe Id of the Device
ErrorsNOT_FOUND deviceEnablerId or deviceId not found or deviceEnablerId not applied to deviceId
NULL_ARGUMENT deviceEnablerId or deviceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceDeviceEnablers
Description

Tests if this user can order DeviceEnablers. 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 DeviceEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveDeviceEnablerAhead
Description

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

Parametersosid.id.IddeviceEnablerIdthe Id of a DeviceEnabler
osid.id.IddeviceIdthe Id of a Device
osid.id.IdreferenceIdthe reference device enabler Id
ErrorsNOT_FOUND deviceEnablerId, deviceId, or referenceId not found or, deviceEnablerId or referenceId not related to deviceId
NULL_ARGUMENT deviceEnablerId, deviceId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveDeviceEnablerBehind
Description

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

Parametersosid.id.IddeviceEnablerIdthe Id of a DeviceEnabler
osid.id.IddeviceIdthe Id of a Device
osid.id.IdreferenceIdthe reference device enabler Id
ErrorsNOT_FOUND deviceEnablerId, deviceId, or referenceId not found or, deviceEnablerId or referenceId not related to deviceId
NULL_ARGUMENT deviceEnablerId, deviceId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderDeviceEnablers
Description

Reorders a set of device enablers for a device.

Parametersosid.id.Id[]deviceEnablerIdsthe Ids for a set of DeviceEnablers
osid.id.IddeviceIdthe Id of a Device
ErrorsNOT_FOUND deviceConstraienrId not found or, a deviceEnablerId not related to deviceId
NULL_ARGUMENT deviceEnablerIds or deviceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.