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

This session provides methods to retrieve TriggerEnabler to System mappings. A TriggerEnabler may appear in multiple System objects. Each system may have its own authorizations governing who is allowed to look at it.

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
MethodcanLookupTriggerEnablerSystemMappings
Description

Tests if this user can perform lookups of trigger enabler/system 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.
MethoduseComparativeTriggerEnablerSystemView
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.
MethodusePlenaryTriggerEnablerSystemView
Description

A complete view of the TriggerEnabler and System 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.
MethodgetTriggerEnablerIdsBySystem
Description

Gets the list of TriggerEnablerIds associated with a System.

Parametersosid.id.IdsystemId Id of the System
Returnosid.id.IdListlist of related trigger enabler Ids
ErrorsNOT_FOUND systemId is not found
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTriggerEnablersBySystem
Description

Gets the list of trigger enablers associated with a System.

Parametersosid.id.IdsystemId Id of the System
Returnosid.control.rules.TriggerEnablerListlist of related trigger enablers
ErrorsNOT_FOUND systemId is not found
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTriggerEnablerIdsBySystems
Description

Gets the list of TriggerEnabler Ids corresponding to a list of Systems.

Parametersosid.id.IdListsystemIdslist of system Ids
Returnosid.id.IdListlist of trigger enabler Ids
ErrorsNULL_ARGUMENT systemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTriggerEnablersBySystems
Description

Gets the list of trigger enablers corresponding to a list of Systems

Parametersosid.id.IdListsystemIdslist of system Ids
Returnosid.control.rules.TriggerEnablerListlist of trigger enablers
ErrorsNULL_ARGUMENT systemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSystemIdsByTriggerEnabler
Description

Gets the System Ids mapped to a TriggerEnabler.

Parametersosid.id.IdtriggerEnablerId Id of a TriggerEnabler
Returnosid.id.IdListlist of system 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.
MethodgetSystemsByTriggerEnabler
Description

Gets the Systems mapped to a TriggerEnabler.

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