Interface | osid.control.rules.TriggerEnablerNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
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 | canRegisterForTriggerEnablerNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedSystemView | ||
Description |
Federates the view for methods in this session. A federated view will include enablers in systems which are children of this system in the system hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedSystemView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this system only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableTriggerEnablerNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableTriggerEnablerNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeTriggerEnablerNotification | ||
Description |
Acknowledge a trigger enabler notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewTriggerEnablers | ||
Description |
Register for notifications of new trigger enablers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedTriggerEnablers | ||
Description |
Registers for notification of updated trigger enablers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedTriggerEnabler | ||
Description |
Registers for notification of an updated trigger
enabler. | ||
Parameters | osid.id.Id | triggerEnablerId | the Id of the TriggerEnabler to monitor |
Errors | NULL_ARGUMENT | triggerEnablerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedTriggerEnablers | ||
Description |
Registers for notification of deleted trigger enablers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedTriggerEnabler | ||
Description |
Registers for notification of a deleted trigger
enabler. | ||
Parameters | osid.id.Id | triggerEnablerId | the Id of the TriggerEnabler to monitor |
Errors | NULL_ARGUMENT | triggerEnablerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |