Interface WorkflowRequestCompletionNotifier
-
- All Known Implementing Classes:
DefaultWorkflowRequestCompletionNotifier
public interface WorkflowRequestCompletionNotifier
Responsible for notifying the async message fabric concerning the completion of aTransitionRequest
orWorkflowJobSchedulingRequest
orWorkflowJobUnschedulingRequest
. For completions where aContextStateAware
record is available, theNotificationManager
should be favored over this facility. For cases where such a record is not available (e.g. missing record), it is generally ok to use this notifier, since the requirements of NotificationManager are not able to be met.- See Also:
WorkflowRequestCompletion
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
notifyOfCompletion(TransitionRequest request, boolean success, Exception e)
Sends notification of aTransitionRequest's
completion including whether success or failure.boolean
notifyOfCompletion(WorkflowJobSchedulingRequest request, boolean success, Exception e)
Sends notification of aWorkflowJobSchedulingRequest's
completion including whether success or failure.boolean
notifyOfCompletion(WorkflowJobUnschedulingRequest request, boolean success, Exception e)
Sends notification of aWorkflowJobUnschedulingRequest's
completion including whether success or failure.
-
-
-
Method Detail
-
notifyOfCompletion
boolean notifyOfCompletion(@NonNull TransitionRequest request, boolean success, @Nullable Exception e)
Sends notification of aTransitionRequest's
completion including whether success or failure.- Parameters:
request
-TransitionRequest
the completion of which to send a notification.success
- Whether theTransitionRequest
was successful or failed.e
-Exception
related to the request's failure if applicable.- Returns:
- Whether the notification was sent successfully.
-
notifyOfCompletion
boolean notifyOfCompletion(@NonNull WorkflowJobSchedulingRequest request, boolean success, @Nullable Exception e)
Sends notification of aWorkflowJobSchedulingRequest's
completion including whether success or failure.- Parameters:
request
-WorkflowJobSchedulingRequest
the completion of which to send a notification.success
- Whether theWorkflowJobSchedulingRequest
was successful or failed.e
-Exception
related to the request's failure if applicable.- Returns:
- Whether the notification was sent successfully.
-
notifyOfCompletion
boolean notifyOfCompletion(@NonNull WorkflowJobUnschedulingRequest request, boolean success, @Nullable Exception e)
Sends notification of aWorkflowJobUnschedulingRequest's
completion including whether success or failure.- Parameters:
request
-WorkflowJobUnschedulingRequest
the completion of which to send a notification.success
- Whether theWorkflowJobUnschedulingRequest
was successful or failed.e
-Exception
related to the request's failure if applicable.- Returns:
- Whether the notification was sent successfully.
-
-