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

This session provides methods to re-assign Triggers to System mappings. A Trigger may appear in multiple System objects and removing the last reference to a Trigger is the equivalent of deleting it. Each System may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Trigger to another System is not a copy operation (eg: does not change its Id ).

MethodcanAssignTriggers
Description

Tests if this user can alter trigger/system 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 assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignTriggersToSystem
Description

Tests if this user can alter trigger/system 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 assignment operations to unauthorized users.

Parametersosid.id.IdsystemIdthe Id of the System
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT systemId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableSystemIds
Description

Gets a list of systems including and under the given system node in which any trigger can be assigned.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.id.IdListlist of assignable system Ids
ErrorsNULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableSystemIdsForTrigger
Description

Gets a list of systems including and under the given system node in which a specific trigger can be assigned.

Parametersosid.id.IdsystemIdthe Id of the System
osid.id.IdtriggerIdthe Id of the Trigger
Returnosid.id.IdListlist of assignable system Ids
ErrorsNULL_ARGUMENT systemId or triggerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignTriggerToSystem
Description

Adds an existing Trigger to a System.

Parametersosid.id.IdtriggerIdthe Id of the Trigger
osid.id.IdsystemIdthe Id of the System
ErrorsALREADY_EXISTS triggerId is already assigned to systemId
NOT_FOUND triggerId or systemId not found
NULL_ARGUMENT triggerId or systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignTriggerFromSystem
Description

Removes a Trigger from a System.

Parametersosid.id.IdtriggerIdthe Id of the Trigger
osid.id.IdsystemIdthe Id of the System
ErrorsNOT_FOUND triggerId or systemId not found or triggerId not assigned to systemId
NULL_ARGUMENT triggerId or systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignTriggerToSystem
Description

Moves a Trigger from one System to another. Mappings to other Systems are unaffected.

Parametersosid.id.IdtriggerIdthe Id of the Trigger
osid.id.IdfromSystemIdthe Id of the current System
osid.id.IdtoSystemIdthe Id of the destination System
ErrorsNOT_FOUND triggerId, fromSystemId, or toSystemId not found or triggerId not mapped to fromSystemId
NULL_ARGUMENT triggerId, fromSystemId, or toSystemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.