com.broadleafcommerce.data.tracking.core.transition

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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WorkflowRequestCompletion(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 Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Tracking	getChangeTracking() All of the information contained within Tracking for the target record of this transition.
String	getErrorMessage() If an error was encountered, this is the related message.
String	getErrorTrace() If an error was encountered, this is the related stack trace.
Class<?>	getRequestType() The type of the request.
Instant	getTimestamp() Time of completion.
String	getToken()
Map<String,String>	getTransferTypeIdMap() ID of the transfer items involved in a workflow request mapped by the TransferType.
int	hashCode()
boolean	isSuccess() Whether the request was successfully handled or encountered an error.
void	setChangeTracking(Tracking changeTracking) All of the information contained within Tracking for the target record of this transition.
void	setToken(String token)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkflowRequestCompletion

public WorkflowRequestCompletion(boolean success,
                                 Map<String,String> transferTypeIdMap,
                                 Class<?> requestType,
                                 String errorMessage,
                                 String errorTrace,
                                 Instant timestamp,
                                 String token,
                                 Tracking changeTracking)

WorkflowRequestCompletion

public WorkflowRequestCompletion(boolean success,
                                 Map<String,String> transferTypeIdMap,
                                 Class<?> requestType,
                                 String errorMessage,
                                 String errorTrace,
                                 Instant timestamp)

Method Detail

isSuccess

public boolean isSuccess()

Whether the request was successfully handled or encountered an error.

getTransferTypeIdMap

public Map<String,String> getTransferTypeIdMap()

ID of the transfer items involved in a workflow request mapped by the TransferType. Could be the id of a change summary, summary group, or deployment.

getRequestType

public Class<?> getRequestType()

The type of the request. Could be any of the implementations of TransitionRequest such as WorkflowPromoteRequest, WorkflowRebaseRequest, &c. or a WorkflowJobSchedulingRequest or a WorkflowJobUnschedulingRequest.

getErrorMessage

public String getErrorMessage()

If an error was encountered, this is the related message.

getErrorTrace

public String getErrorTrace()

If an error was encountered, this is the related stack trace.

getTimestamp

public Instant getTimestamp()

Time of completion.

getToken

public String getToken()

Specified by:

getToken in interface com.broadleafcommerce.common.messaging.Securable

getChangeTracking

public Tracking getChangeTracking()

All of the information contained within Tracking 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

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setToken

public void setToken(String token)

Specified by:

setToken in interface com.broadleafcommerce.common.messaging.Securable

setChangeTracking

public void setChangeTracking(Tracking changeTracking)

All of the information contained within Tracking 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 within Tracking for the record of this transition