org.broadleafcommerce.core.workflow
Class BaseActivity

java.lang.Object
  org.broadleafcommerce.core.workflow.BaseActivity

All Implemented Interfaces:

Activity, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

Direct Known Subclasses:

AddFulfillmentGroupItemActivity, AddOrderItemActivity, AutoBundleActivity, BaseExtensionActivity, CompleteOrderActivity, CompositeActivity, CompositeActivity, CompositeActivity, ConsolidateFulfillmentFeesActivity, FulfillmentGroupMerchandiseTotalActivity, FulfillmentGroupPricingActivity, FulfillmentItemPricingActivity, OfferActivity, PaymentActivity, PaymentServiceActivity, PriceOrderIfNecessaryActivity, PricingServiceActivity, RecordOfferUsageActivity, RemoveFulfillmentGroupItemActivity, RemoveOrderItemActivity, RemoveOrderMultishipOptionActivity, ShippingActivity, ShippingOfferActivity, TaxActivity, ThirdPartyInteractionLatencySimulationActivity, TotalActivity, UpdateFulfillmentGroupItemActivity, UpdateOrderItemActivity, UpdateOrderMultishipOptionActivity, ValidateAddRequestActivity, ValidateRemoveRequestActivity, ValidateUpdateRequestActivity, VerifyCustomerMaxOfferUsesActivity, VerifyFulfillmentGroupItemsActivity

public abstract class BaseActivity
extends Object
implements Activity

Constructor Summary

BaseActivity()

Method Summary

boolean	getAutomaticallyRegisterRollbackHandler() Whether or not this activity should automatically register a configured RollbackHandler with the ActivityStateManager.
String	getBeanName()
ErrorHandler	getErrorHandler() Get the fine-grained error handler wired up for this Activity
RollbackHandler	getRollbackHandler() Retrieve the RollbackHandler instance that should be called by the ActivityStateManager in the event of a workflow execution problem.
String	getRollbackRegion() Retrieve the optional region label for the RollbackHandler.
Map<String,Object>	getStateConfiguration() Retrieve any user-defined state that should accompany the RollbackHandler.
void	setAutomaticallyRegisterRollbackHandler(boolean automaticallyRegisterRollbackHandler) Whether or not this activity should automatically register a configured RollbackHandler with the ActivityStateManager.
void	setBeanName(String beanName)
void	setErrorHandler(ErrorHandler errorHandler)
void	setRollbackHandler(RollbackHandler rollbackHandler) Set the RollbackHandler instance that should be called by the ActivityStateManager in the event of a workflow execution problem.
void	setRollbackRegion(String rollbackRegion) Set the optional region label for the RollbackHandler.
void	setStateConfiguration(Map<String,Object> stateConfiguration) Set any user-defined state that should accompany the RollbackHandler.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.core.workflow.Activity

execute

Constructor Detail

BaseActivity

public BaseActivity()

Method Detail

getErrorHandler

public ErrorHandler getErrorHandler()

Description copied from interface: Activity

Get the fine-grained error handler wired up for this Activity

Specified by:

getErrorHandler in interface Activity

Returns:

setBeanName

public void setBeanName(String beanName)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Specified by:

setErrorHandler in interface Activity

getBeanName

public String getBeanName()

Specified by:

getBeanName in interface Activity

getRollbackHandler

public RollbackHandler getRollbackHandler()

Description copied from interface: Activity

Retrieve the RollbackHandler instance that should be called by the ActivityStateManager in the event of a workflow execution problem. This RollbackHandler will presumably perform some compensating operation to revert state for the activity.

Specified by:

getRollbackHandler in interface Activity

Returns:

the handler responsible for reverting state for the activity

setRollbackHandler

public void setRollbackHandler(RollbackHandler rollbackHandler)

Description copied from interface: Activity

Set the RollbackHandler instance that should be called by the ActivityStateManager in the event of a workflow execution problem. This RollbackHandler will presumably perform some compensating operation to revert state for the activity.

Specified by:

setRollbackHandler in interface Activity

Parameters:

rollbackHandler - the handler responsible for reverting state for the activity

getRollbackRegion

public String getRollbackRegion()

Description copied from interface: Activity

Retrieve the optional region label for the RollbackHandler. Setting a region allows partitioning of groups of RollbackHandlers for more fine grained control of rollback behavior. Explicit calls to the ActivityStateManager API in an ErrorHandler instance allows explicit rollback of specific rollback handler regions. Note, to disable automatic rollback behavior and enable explicit rollbacks via the API, the workflow.auto.rollback.on.error property should be set to false in your implementation's runtime property configuration.

Specified by:

getRollbackRegion in interface Activity

Returns:

the rollback region label for the RollbackHandler instance

setRollbackRegion

public void setRollbackRegion(String rollbackRegion)

Description copied from interface: Activity

Set the optional region label for the RollbackHandler. Setting a region allows partitioning of groups of RollbackHandlers for more fine grained control of rollback behavior. Explicit calls to the ActivityStateManager API in an ErrorHandler instance allows explicit rollback of specific rollback handler regions. Note, to disable automatic rollback behavior and enable explicit rollbacks via the API, the workflow.auto.rollback.on.error property should be set to false in your implementation's runtime property configuration.

Specified by:

setRollbackRegion in interface Activity

Parameters:

rollbackRegion - the rollback region label for the RollbackHandler instance

getStateConfiguration

public Map<String,Object> getStateConfiguration()

Description copied from interface: Activity

Retrieve any user-defined state that should accompany the RollbackHandler. This configuration will be passed to the RollbackHandler implementation at runtime.

Specified by:

getStateConfiguration in interface Activity

Returns:

any user-defined state configuratio necessary for the execution of the RollbackHandler

setStateConfiguration

public void setStateConfiguration(Map<String,Object> stateConfiguration)

Description copied from interface: Activity

Set any user-defined state that should accompany the RollbackHandler. This configuration will be passed to the RollbackHandler implementation at runtime.

Specified by:

setStateConfiguration in interface Activity

Parameters:

stateConfiguration - any user-defined state configuration necessary for the execution of the RollbackHandler

getAutomaticallyRegisterRollbackHandler

public boolean getAutomaticallyRegisterRollbackHandler()

Description copied from interface: Activity

Whether or not this activity should automatically register a configured RollbackHandler with the ActivityStateManager. It is useful to adjust this value if you plan on using the ActivityStateManager API to register RollbackHandlers explicitly in your code. The default value is true.

Specified by:

getAutomaticallyRegisterRollbackHandler in interface Activity

Returns:

Whether or not to automatically register a RollbackHandler with the ActivityStateManager

setAutomaticallyRegisterRollbackHandler

public void setAutomaticallyRegisterRollbackHandler(boolean automaticallyRegisterRollbackHandler)

Description copied from interface: Activity

Whether or not this activity should automatically register a configured RollbackHandler with the ActivityStateManager. It is useful to adjust this value if you plan on using the ActivityStateManager API to register RollbackHandlers explicitly in your code. The default value is true.

Specified by:

setAutomaticallyRegisterRollbackHandler in interface Activity

Parameters:

automaticallyRegisterRollbackHandler - Whether or not to automatically register a RollbackHandler with the ActivityStateManager