Package com.broadleafcommerce.data.tracking.core.transition

Class WorkflowPromoteRequest

java.lang.Object

com.broadleafcommerce.data.tracking.core.transition.WorkflowPromoteRequest

All Implemented Interfaces:

com.broadleafcommerce.common.messaging.Securable, TargetRelatedRequest, TransitionRequest, Serializable

public class WorkflowPromoteRequest
extends Object
implements TargetRelatedRequest

A request for a promotion operation, moving all changes related to a promotion id from the sandboxable state of an item to the requested target sandbox state.

Author:

Jeff Fischer

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WorkflowPromoteRequest(Map<String,String> transferTypeIdMap, String contextId, String sandboxId, String author, Integer level, String entity, Integer targetLevel, String promotionId)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getApplicationId()	The applicationId that should be used to filter the results from TrackableRepository.findPromotable(WorkflowPromoteRequest).
String	getAuthor()	The author of the promotion.
String	getCatalogId()	The catalogId that should be used to filter the results from TrackableRepository.findPromotable(WorkflowPromoteRequest).
String	getContextId()	The contextId used to identify the originating item to promote.
String	getEntity()	The entity's class name for this promotion.
Integer	getLevel()	The level at which the originating item resides.
String	getMessage()	A user defined message to go along with the state transition.
String	getPromotionId()
String	getRouteKey()
String	getSandboxId()	The id for the sandbox in which the originating item resides.
String	getStage()	The informational stage in which the originating item resides.
Integer	getTargetLevel()	The level for which the transition is targeted.
String	getTargetSandboxId()	The id for the sandbox for which the transition is targeted.
String	getTargetStage()	The informational stage for which the transition is targeted.
String	getToken()
Map<String,String>	getTransferTypeIdMap()	Get the IDs of the transition requested mapped by the TransferType.
WorkflowTransitionRequest	getTransitionRequest()
Set<String>	getVisibleFromCatalog()	Context list of the contextIds for the deep catalog tree parenting the TransitionRequest.getCatalogId().
int	hashCode()
void	setApplicationId(String applicationId)	The applicationId that should be used to filter the results from TrackableRepository.findPromotable(WorkflowPromoteRequest).
void	setCatalogId(String catalogId)	The catalogId that should be used to filter the results from TrackableRepository.findPromotable(WorkflowPromoteRequest).
void	setEntity(String entity)
void	setMessage(String message)	A user defined message to go along with the state transition.
void	setRouteKey(String routeKey)
void	setStage(String stage)	The informational stage in which the originating item resides.
void	setTargetSandboxId(String targetSandboxId)	The id for the sandbox for which the transition is targeted.
void	setTargetStage(String targetStage)	The informational stage for which the transition is targeted.
void	setToken(String token)
void	setVisibleFromCatalog(Set<String> visibleFromCatalog)	Context list of the contextIds for the deep catalog tree parenting the TransitionRequest.getCatalogId().
String	toString()
WorkflowPromoteRequest	withApplication(String application)
WorkflowPromoteRequest	withCatalog(String catalog)
WorkflowPromoteRequest	withMessage(String message)
WorkflowPromoteRequest	withRouteKey(String routeKey)
WorkflowPromoteRequest	withStage(String stage)
WorkflowPromoteRequest	withTargetSandboxId(String targetSandboxId)
WorkflowPromoteRequest	withTargetStage(String targetStage)
WorkflowPromoteRequest	withToken(String token)

Methods inherited from class java.lang.Object

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

Constructor Details

WorkflowPromoteRequest

public WorkflowPromoteRequest(Map<String,String> transferTypeIdMap,
 String contextId,
 String sandboxId,
 String author,
 Integer level,
 String entity,
 Integer targetLevel,
 String promotionId)

Method Details

withMessage

public WorkflowPromoteRequest withMessage(String message)

withToken

public WorkflowPromoteRequest withToken(String token)

withCatalog

public WorkflowPromoteRequest withCatalog(String catalog)

withRouteKey

public WorkflowPromoteRequest withRouteKey(String routeKey)

withApplication

public WorkflowPromoteRequest withApplication(String application)

withStage

public WorkflowPromoteRequest withStage(String stage)

withTargetStage

public WorkflowPromoteRequest withTargetStage(String targetStage)

withTargetSandboxId

public WorkflowPromoteRequest withTargetSandboxId(String targetSandboxId)

getTransitionRequest

public WorkflowTransitionRequest getTransitionRequest()

getPromotionId

public String getPromotionId()

getTargetSandboxId

public String getTargetSandboxId()

Description copied from interface: TargetRelatedRequest

The id for the sandbox for which the transition is targeted.

Specified by:

getTargetSandboxId in interface TargetRelatedRequest

Returns:

The id for the sandbox for which the transition is targeted

getTargetStage

public String getTargetStage()

Description copied from interface: TargetRelatedRequest

The informational stage for which the transition is targeted.

Specified by:

getTargetStage in interface TargetRelatedRequest

Returns:

The informational stage for which the transition is targeted

getTargetLevel

public Integer getTargetLevel()

Description copied from interface: TargetRelatedRequest

The level for which the transition is targeted. See Tracking.getLevel() for more information.

Specified by:

getTargetLevel in interface TargetRelatedRequest

Returns:

The level for which the transition is targeted

setTargetSandboxId

public void setTargetSandboxId(String targetSandboxId)

Description copied from interface: TargetRelatedRequest

The id for the sandbox for which the transition is targeted.

Specified by:

setTargetSandboxId in interface TargetRelatedRequest

Parameters:

targetSandboxId - The id for the sandbox for which the transition is targeted

setTargetStage

public void setTargetStage(String targetStage)

Description copied from interface: TargetRelatedRequest

The informational stage for which the transition is targeted.

Specified by:

setTargetStage in interface TargetRelatedRequest

Parameters:

targetStage - The informational stage for which the transition is targeted

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

getTransferTypeIdMap

public Map<String,String> getTransferTypeIdMap()

Description copied from interface: TransitionRequest

Get the IDs of the transition requested mapped by the TransferType. Could be the ids of a change summary, summary group, or deployment. A single summary could be one of a large group of changes or a deployment thereby leading to the map containing the ID of a the individual summary related to 1 set of changes being transitioned and the ID of the entire group. This is used to clean up state once all of the related transition requests have completed.

Specified by:

getTransferTypeIdMap in interface TransitionRequest

getContextId

public String getContextId()

Description copied from interface: TransitionRequest

The contextId used to identify the originating item to promote. See Trackable.getContextId().

Specified by:

getContextId in interface TransitionRequest

Returns:

The contextId used to identify the originating item to promote

getSandboxId

public String getSandboxId()

Description copied from interface: TransitionRequest

The id for the sandbox in which the originating item resides.

Specified by:

getSandboxId in interface TransitionRequest

Returns:

The id for the sandbox in which the originating item resides

getAuthor

public String getAuthor()

Description copied from interface: TransitionRequest

The author of the promotion. This is useful when finding originating domain items in a user sandbox for promotion to a subsequent level. User sandbox changes are partially identified by their author.

Specified by:

getAuthor in interface TransitionRequest

Returns:

The author of the promotion

getLevel

public Integer getLevel()

Description copied from interface: TransitionRequest

The level at which the originating item resides. See Tracking.getLevel() for more information.

Specified by:

getLevel in interface TransitionRequest

Returns:

The level at which the originating item resides

getRouteKey

public String getRouteKey()

Specified by:

getRouteKey in interface TransitionRequest

getEntity

public String getEntity()

Description copied from interface: TransitionRequest

The entity's class name for this promotion.

Specified by:

getEntity in interface TransitionRequest

Returns:

The entity's class name for this promotion

getStage

public String getStage()

Description copied from interface: TransitionRequest

The informational stage in which the originating item resides.

Specified by:

getStage in interface TransitionRequest

Returns:

The informational stage in which the originating item resides.

getCatalogId

public String getCatalogId()

Description copied from interface: TransitionRequest

The catalogId that should be used to filter the results from TrackableRepository.findPromotable(WorkflowPromoteRequest). Can be null if the item is not catalog discriminatable.

Specified by:

getCatalogId in interface TransitionRequest

Returns:

The catalogId that should be used to filter the results

getApplicationId

public String getApplicationId()

Description copied from interface: TransitionRequest

The applicationId that should be used to filter the results from TrackableRepository.findPromotable(WorkflowPromoteRequest). Can be null if the item is not application discriminatable.

Specified by:

getApplicationId in interface TransitionRequest

Returns:

The applicationId that should be used to filter the results

getVisibleFromCatalog

public Set<String> getVisibleFromCatalog()

Description copied from interface: TransitionRequest

Context list of the contextIds for the deep catalog tree parenting the TransitionRequest.getCatalogId(). This is not a value that is generally populated via JSON. Rather, this variable is generally calculated via lookup of catalog using catalogId. This is helpful for identifying inherited targets during a promotion.

Specified by:

getVisibleFromCatalog in interface TransitionRequest

Returns:

Context list of the contextIds for the deep catalog tree parenting the TransitionRequest.getCatalogId()

getMessage

public String getMessage()

Description copied from interface: TransitionRequest

A user defined message to go along with the state transition. This is generally descriptive of the purpose served by the transition.

Specified by:

getMessage in interface TransitionRequest

Returns:

A user defined message to go along with the state transition

getToken

public String getToken()

Specified by:

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

setRouteKey

public void setRouteKey(String routeKey)

setEntity

public void setEntity(String entity)

setStage

public void setStage(String stage)

Description copied from interface: TransitionRequest

The informational stage in which the originating item resides.

Specified by:

setStage in interface TransitionRequest

Parameters:

stage - The informational stage in which the originating item resides.

setCatalogId

public void setCatalogId(String catalogId)

Description copied from interface: TransitionRequest

The catalogId that should be used to filter the results from TrackableRepository.findPromotable(WorkflowPromoteRequest). Can be null if the item is not catalog discriminatable.

Specified by:

setCatalogId in interface TransitionRequest

Parameters:

catalogId - The catalogId that should be used to filter the results

setApplicationId

public void setApplicationId(String applicationId)

Description copied from interface: TransitionRequest

The applicationId that should be used to filter the results from TrackableRepository.findPromotable(WorkflowPromoteRequest). Can be null if the item is not application discriminatable.

Specified by:

setApplicationId in interface TransitionRequest

Parameters:

applicationId - The applicationId that should be used to filter the results

setVisibleFromCatalog

public void setVisibleFromCatalog(Set<String> visibleFromCatalog)

Description copied from interface: TransitionRequest

Context list of the contextIds for the deep catalog tree parenting the TransitionRequest.getCatalogId(). This is not a value that is generally populated via JSON. Rather, this variable is generally calculated via lookup of catalog using catalogId. This is helpful for identifying inherited targets during a promotion.

Specified by:

setVisibleFromCatalog in interface TransitionRequest

Parameters:

visibleFromCatalog - list of the contextIds for the deep catalog tree parenting the TransitionRequest.getCatalogId()

setMessage

public void setMessage(String message)

Description copied from interface: TransitionRequest

A user defined message to go along with the state transition. This is generally descriptive of the purpose served by the transition.

Specified by:

setMessage in interface TransitionRequest

Parameters:

message - A user defined message to go along with the state transition

setToken

public void setToken(String token)

Specified by:

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