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

This session provides methods to retrieve TriggerEnabler to Trigger mappings. A Device with multiple TriggerEnablers means any positive rule evaluation across the enablers result in an effective Device.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated system view: All methods in this session operate, retrieve and pertain trigger enablers defined explicitly in the current system
  • federated system view: All methods in this session operate, retrieve and pertain to all trigger enablers defined in this system and any other trigger enablers implicitly available in this system through system inheritence.
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.
MethodcanLookupTriggerEnablerRules
Description

Tests if this user can perform lookups of trigger enabler/trigger mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeTriggerEnablerRuleView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryTriggerEnablerRuleView
Description

A complete view of the TriggerEnabler and Trigger returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedSystemView
Description

Federates the view for methods in this session. A federated view will include trigger enablers in systems which are children of this system in the system hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedSystemView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this system only.

CompliancemandatoryThis method is must be implemented.
MethodgetTriggerEnablerIdsForTrigger
Description

Gets the TriggerEnabler Id associated with a Trigger.

Parametersosid.id.IdtriggerId Id of the Trigger
Returnosid.id.IdListthe trigger enabler Ids
ErrorsNOT_FOUND triggerId is not found
NULL_ARGUMENT triggerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTriggerEnablersForTrigger
Description

Gets the TriggerEnablers associated with a Trigger.

Parametersosid.id.IdtriggerId Id of the Trigger
Returnosid.control.rules.TriggerEnablerListthe trigger enablers
ErrorsNOT_FOUND triggerId is not found
NULL_ARGUMENT triggerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTriggerIdsForTriggerEnabler
Description

Gets the Trigger Ids mapped to a TriggerEnabler.

Parametersosid.id.IdtriggerEnablerId Id of a TriggerEnabler
Returnosid.id.IdListlist of trigger Ids
ErrorsNOT_FOUND triggerEnablerId is not found
NULL_ARGUMENT triggerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTriggersForTriggerEnabler
Description

Gets the Triggers mapped to a TriggerEnabler.

Parametersosid.id.IdtriggerEnablerId Id of a TriggerEnabler
Returnosid.control.TriggerListlist of triggers
ErrorsNOT_FOUND triggerEnablerId is not found
NULL_ARGUMENT triggerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.