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

This session provides methods to re-assign TriggerEnabler to System mappings. A TriggerEnabler may appear in multiple System objects and removing the last reference to a TriggerEnabler 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 TriggerEnabler to another System is not a copy operation (eg: does not change its Id ).

MethodcanAssignTriggerEnablers
Description

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

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

Tests if this user can alter trigger enabler/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 lookup 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 enabler can be assigned.

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

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

Parametersosid.id.IdsystemIdthe Id of the System
osid.id.IdtriggerEnablerIdthe Id of the TriggerEnabler
Returnosid.id.IdListlist of assignable system Ids
ErrorsNULL_ARGUMENT systemId or triggerEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignTriggerEnablerToSystem
Description

Adds an existing TriggerEnabler to a System.

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

Removes a TriggerEnabler from a System.

Parametersosid.id.IdtriggerEnablerIdthe Id of the TriggerEnabler
osid.id.IdsystemIdthe Id of the System
ErrorsNOT_FOUND triggerEnablerId or systemId not found or triggerEnablerId already assigned to systemId
NULL_ARGUMENT triggerEnablerId or systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignTriggerEnablerToSystem
Description

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

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