Package com.broadleafcommerce.orchestration.internal

Class WaitStep

java.lang.Object

com.broadleafcommerce.orchestration.internal.WaitStep

All Implemented Interfaces:

SimpleActivity, InterruptAware, Interruptible

public class WaitStep
extends Object
implements SimpleActivity, InterruptAware

Special type of step handled internally by Broadleaf. Represents a simple thread pause for a specified duration. Suitable for short wait intervals (not generally suited for long waits).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WAIT_COMPLETION_RESPONSE
protected static final String	WAIT_STEP_ACTIVITY_DESCRIPTION
protected static final String	WAIT_STEP_ACTIVITY_NAME

Constructor Summary

Constructors

Constructor	Description
WaitStep()
WaitStep(Duration waitDuration, long startTime, Duration interruptPollingInterval, Duration timeout)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	A human-readable description for this activity.
Duration	getInterruptPollingInterval()
String	getName()	The unique name for this business task.
long	getStartTime()
Duration	getTimeout()
Duration	getWaitDuration()
void	interrupt()	Perform necessary operations to immediately wrap up execution before cancellation or pause
void	setInterruptPollingInterval(Duration interruptPollingInterval)
void	setStartTime(long startTime)
void	setTimeout(Duration timeout)
void	setWaitDuration(Duration waitDuration)
ActivityResponse	start(Map<String,Object> context)	Begin execution of the task

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.broadleafcommerce.orchestration.internal.Interruptible

allowThreadInterrupt, isInterrupted

Methods inherited from interface com.broadleafcommerce.orchestration.client.SimpleActivity

getLocalCache, getWorkflowInformation, log, putLocalCache

Field Details

WAIT_STEP_ACTIVITY_NAME

protected static final String WAIT_STEP_ACTIVITY_NAME

See Also:

• Constant Field Values

WAIT_STEP_ACTIVITY_DESCRIPTION

protected static final String WAIT_STEP_ACTIVITY_DESCRIPTION

See Also:

• Constant Field Values

WAIT_COMPLETION_RESPONSE

public static final String WAIT_COMPLETION_RESPONSE

See Also:

• Constant Field Values

Constructor Details

WaitStep

public WaitStep(Duration waitDuration,
 long startTime,
 Duration interruptPollingInterval,
 Duration timeout)

WaitStep

public WaitStep()

Method Details

interrupt

public void interrupt()

Description copied from interface: InterruptAware

Perform necessary operations to immediately wrap up execution before cancellation or pause

Specified by:

interrupt in interface InterruptAware

start

public ActivityResponse start(Map<String,Object> context)

Description copied from interface: SimpleActivity

Begin execution of the task

Specified by:

start in interface SimpleActivity

Parameters:

context - Any information needed to perform the task

Returns:

status and context data resulting from execution

getName

public String getName()

Description copied from interface: SimpleActivity

The unique name for this business task. Should match the Spring bean name for the activity bean.

Specified by:

getName in interface SimpleActivity

Returns:

The unique name for this business task.

getDescription

public String getDescription()

Description copied from interface: SimpleActivity

A human-readable description for this activity. Generally also unique like the name to ensure clarity in the admin UI.

Specified by:

getDescription in interface SimpleActivity

Returns:

A human-readable description for this activity.

getWaitDuration

public Duration getWaitDuration()

setWaitDuration

public void setWaitDuration(Duration waitDuration)

getTimeout

public Duration getTimeout()

setTimeout

public void setTimeout(Duration timeout)

getStartTime

public long getStartTime()

setStartTime

public void setStartTime(long startTime)

getInterruptPollingInterval

public Duration getInterruptPollingInterval()

setInterruptPollingInterval

public void setInterruptPollingInterval(Duration interruptPollingInterval)