Interface | osid.control.rules.TriggerEnablerRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
Method | getSystemId | ||
Description |
Gets the | ||
Return | osid.id.Id | the System Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystem | ||
Description |
Gets the | ||
Return | osid.control.System | the system | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAssignTriggerEnablers | ||
Description |
Tests if this user can alter trigger enabler/trigger
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
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | assignTriggerEnablerToTrigger | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | triggerEnablerId | the Id of the TriggerEnabler |
osid.id.Id | triggerId | the Id of the Trigger | |
Errors | ALREADY_EXISTS | triggerEnablerId already applied to triggerId | |
NOT_FOUND | triggerEnablerId or triggerId not found | ||
NULL_ARGUMENT | triggerEnablerId or triggerId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignTriggerEnablerFromTrigger | ||
Description |
Removes a | ||
Parameters | osid.id.Id | triggerEnablerId | the Id of the TriggerEnabler |
osid.id.Id | triggerId | the Id of the Trigger | |
Errors | NOT_FOUND | triggerEnablerId or triggerId not found or
triggerEnablerId not applied to triggerId | |
NULL_ARGUMENT | triggerEnablerId or triggerId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceTriggerEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if TriggerEnabler ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveTriggerEnablerAhead | ||
Description |
Reorders trigger enablers for a trigger by moving the specified trigger enabler in front of a reference trigger enabler. | ||
Parameters | osid.id.Id | triggerEnablerId | the Id of a TriggerEnabler |
osid.id.Id | triggerId | the Id of a Trigger | |
osid.id.Id | referenceId | the reference trigger enabler Id | |
Errors | NOT_FOUND | triggerEnablerId, triggerId, or referenceId
not found or, triggerEnablerId or referenceId
not related to triggerId | |
NULL_ARGUMENT | triggerEnablerId, triggerId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveTriggerEnablerBehind | ||
Description |
Reorders trigger enablers for a device by moving the specified trigger enabler behind a reference trigger enabler. | ||
Parameters | osid.id.Id | triggerEnablerId | the Id of a TriggerEnabler |
osid.id.Id | triggerId | the Id of a Trigger | |
osid.id.Id | referenceId | the reference trigger enabler Id | |
Errors | NOT_FOUND | triggerEnablerId, triggerId, or referenceId
not found or, triggerEnablerId or referenceId
not related to triggerId | |
NULL_ARGUMENT | triggerEnablerId, triggerId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderTriggerEnablers | ||
Description |
Reorders a set of trigger enablers for a trigger. | ||
Parameters | osid.id.Id[] | triggerEnablerIds | the Ids for a set of TriggerEnablers |
osid.id.Id | triggerId | the Id of a Trigger | |
Errors | NOT_FOUND | triggerId not found or, a triggerEnablerId
not related to triggerId | |
NULL_ARGUMENT | triggerEnablerIds or triggerId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |