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

This session provides methods to apply TriggerEnablers to Triggers. A Trigger with multiple TriggerEnablers means any positive rule evaluation across the enablers result in an effective Trigger.

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

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

Adds an existing TriggerEnabler to a Trigger.

Parametersosid.id.IdtriggerEnablerIdthe Id of the TriggerEnabler
osid.id.IdtriggerIdthe Id of the Trigger
ErrorsALREADY_EXISTS triggerEnablerId already applied to triggerId
NOT_FOUND triggerEnablerId or triggerId not found
NULL_ARGUMENT triggerEnablerId or triggerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignTriggerEnablerFromTrigger
Description

Removes a TriggerEnabler from a Trigger.

Parametersosid.id.IdtriggerEnablerIdthe Id of the TriggerEnabler
osid.id.IdtriggerIdthe Id of the Trigger
ErrorsNOT_FOUND triggerEnablerId or triggerId not found or triggerEnablerId not applied to triggerId
NULL_ARGUMENT triggerEnablerId or triggerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceTriggerEnablers
Description

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

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

Parametersosid.id.IdtriggerEnablerIdthe Id of a TriggerEnabler
osid.id.IdtriggerIdthe Id of a Trigger
osid.id.IdreferenceIdthe reference trigger enabler Id
ErrorsNOT_FOUND triggerEnablerId, triggerId, or referenceId not found or, triggerEnablerId or referenceId not related to triggerId
NULL_ARGUMENT triggerEnablerId, triggerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveTriggerEnablerBehind
Description

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

Parametersosid.id.IdtriggerEnablerIdthe Id of a TriggerEnabler
osid.id.IdtriggerIdthe Id of a Trigger
osid.id.IdreferenceIdthe reference trigger enabler Id
ErrorsNOT_FOUND triggerEnablerId, triggerId, or referenceId not found or, triggerEnablerId or referenceId not related to triggerId
NULL_ARGUMENT triggerEnablerId, triggerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderTriggerEnablers
Description

Reorders a set of trigger enablers for a trigger.

Parametersosid.id.Id[]triggerEnablerIdsthe Ids for a set of TriggerEnablers
osid.id.IdtriggerIdthe Id of a Trigger
ErrorsNOT_FOUND triggerId not found or, a triggerEnablerId not related to triggerId
NULL_ARGUMENT triggerEnablerIds or triggerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.