Interface | osid.workflow.rules.StepProcessorEnablerNotificationSession | ||
---|---|---|---|
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 | getOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Office Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffice | ||
Description |
Gets the | ||
Return | osid.workflow.Office | the office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForStepProcessorEnablerNotifications | ||
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 | useFederatedOfficeView | ||
Description |
Federates the view for methods in this session. A federated view will include enablers in offices which are children of this office in the office hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedOfficeView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this office only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableStepProcessorEnablerNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableStepProcessorEnablerNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeStepProcessorEnablerNotification | ||
Description |
Acknowledge a step processor 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 | registerForNewStepProcessorEnablers | ||
Description |
Register for notifications of new step processor
enablers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedStepProcessorEnablers | ||
Description |
Registers for notification of updated office enabelrs.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedStepProcessorEnabler | ||
Description |
Registers for notification of an updated step processor
enabler. | ||
Parameters | osid.id.Id | stepProcessorEnablerId | the Id of the StepProcessorEnabler to monitor |
Errors | NULL_ARGUMENT | stepProcessorEnablerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedStepProcessorEnablers | ||
Description |
Registers for notification of deleted step processor
enablers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedStepProcessorEnabler | ||
Description |
Registers for notification of a deleted step processor
enabler. | ||
Parameters | osid.id.Id | stepProcessorEnablerId | the Id of the StepProcessorEnabler to monitor |
Errors | NULL_ARGUMENT | stepProcessorEnablerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |