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

This session provides methods to retrieve Trigger to System mappings. A Trigger 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
MethodcanLookupTriggerSystemMappings
Description

Tests if this user can perform lookups of trigger/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.
MethoduseComparativeTriggerSystemView
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.
MethodusePlenaryTriggerSystemView
Description

A complete view of the Trigger 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.
MethodgetTriggerIdsBySystem
Description

Gets the list of Trigger Ids associated with a System.

Parametersosid.id.IdsystemId Id of the System
Returnosid.id.IdListlist of related trigger 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.
MethodgetTriggersBySystem
Description

Gets the list of Triggers associated with a System.

Parametersosid.id.IdsystemId Id of the System
Returnosid.control.TriggerListlist of related triggers
ErrorsNOT_FOUND systemId is not found
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTriggerIdsBySystems
Description

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

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

Gets the list of Trigger corresponding to a list of Systems.

Parametersosid.id.IdListsystemIdslist of system Ids
Returnosid.control.TriggerListlist of triggers
ErrorsNULL_ARGUMENT systemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSystemIdsByTrigger
Description

Gets the System Ids mapped to a Trigger.

Parametersosid.id.IdtriggerId Id of a Trigger
Returnosid.id.IdListlist of systems
ErrorsNOT_FOUND triggerId is not found
NULL_ARGUMENT triggerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSystemsByTrigger
Description

Gets the Systems mapped to a Trigger.

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