OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.TriggerSystemAssignmentSession
Implementsosid.OsidSession
Used Byosid.control.ControlManager
osid.control.ControlProxyManager
Description

This session provides methods to re-assign Triggers to System mappings. A Trigger may appear in multiple Systems 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
Compliancemandatory This 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.IdsystemId the Id of the System
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT systemId is null
Compliancemandatory This 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.IdsystemId the Id of the System
Returnosid.id.IdList list of assignable system Ids
ErrorsNULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This 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.IdsystemId the Id of the System
osid.id.IdtriggerId the Id of the Trigger
Returnosid.id.IdList list of assignable system Ids
ErrorsNULL_ARGUMENT systemId or triggerId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignTriggerToSystem
Description

Adds an existing Trigger to a System.

Parametersosid.id.IdtriggerId the Id of the Trigger
osid.id.IdsystemId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignTriggerFromSystem
Description

Removes a Trigger from a System.

Parametersosid.id.IdtriggerId the Id of the Trigger
osid.id.IdsystemId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignTriggerToSystem
Description

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

Parametersosid.id.IdtriggerId the Id of the Trigger
osid.id.IdfromSystemId the Id of the current System
osid.id.IdtoSystemId the Id of the destination System
ErrorsALREADY_EXISTS triggerId already assigned to toSystemId
NOT_FOUND triggerId, fromSystemId, or toSystemId not found or triggerId not mapped to fromSystemId
NULL_ARGUMENT triggerId, fromSystemId, or toSystemId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.