Class WorkflowRequestCompletion
java.lang.Object
com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion
- All Implemented Interfaces:
com.broadleafcommerce.common.messaging.Securable
,Serializable
public class WorkflowRequestCompletion
extends Object
implements com.broadleafcommerce.common.messaging.Securable, Serializable
A container object for information regarding the completion of a
TransitionRequest
or
WorkflowJobSchedulingRequest
or WorkflowJobUnschedulingRequest
.- Author:
- Nathan Moore (nathandmoore)
- See Also:
-
Constructor Summary
ConstructorDescriptionWorkflowRequestCompletion
(boolean success, Map<String, String> transferTypeIdMap, Class<?> requestType, String errorMessage, String errorTrace, Instant timestamp) WorkflowRequestCompletion
(boolean success, Map<String, String> transferTypeIdMap, Class<?> requestType, String errorMessage, String errorTrace, Instant timestamp, String token, Tracking changeTracking) -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
All of the information contained withinTracking
for the target record of this transition.If an error was encountered, this is the related message.If an error was encountered, this is the related stack trace.Class<?>
The type of the request.Time of completion.getToken()
ID of the transfer items involved in a workflow request mapped by theTransferType
.int
hashCode()
boolean
Whether the request was successfully handled or encountered an error.void
setChangeTracking
(Tracking changeTracking) All of the information contained withinTracking
for the target record of this transition.void
toString()
-
Constructor Details
-
WorkflowRequestCompletion
-
WorkflowRequestCompletion
-
-
Method Details
-
isSuccess
public boolean isSuccess()Whether the request was successfully handled or encountered an error. -
getTransferTypeIdMap
ID of the transfer items involved in a workflow request mapped by theTransferType
. Could be the id of a change summary, summary group, or deployment. -
getRequestType
The type of the request. Could be any of the implementations ofTransitionRequest
such asWorkflowPromoteRequest
,WorkflowRebaseRequest
, &c. or aWorkflowJobSchedulingRequest
or aWorkflowJobUnschedulingRequest
. -
getErrorMessage
If an error was encountered, this is the related message. -
getErrorTrace
If an error was encountered, this is the related stack trace. -
getTimestamp
Time of completion. -
getToken
- Specified by:
getToken
in interfacecom.broadleafcommerce.common.messaging.Securable
-
getChangeTracking
All of the information contained withinTracking
for the target record of this transition. This field is optional and is generally employed by the rebase and promotion flows, as both of these cause unique change details to be created to represent the latest state- Returns:
- All of the information contained within
Tracking
for the record of this transition
-
toString
-
equals
-
canEqual
-
hashCode
public int hashCode() -
setToken
- Specified by:
setToken
in interfacecom.broadleafcommerce.common.messaging.Securable
-
setChangeTracking
All of the information contained withinTracking
for the target record of this transition. This field is optional and is generally employed by the rebase and promotion flows, as both of these cause unique change details to be created to represent the latest state- Parameters:
changeTracking
- All of the information contained withinTracking
for the record of this transition
-