Package com.broadleafcommerce.enterprise.workflow.persistence

Class WorkflowStateManagerImpl

java.lang.Object

com.broadleafcommerce.enterprise.workflow.persistence.WorkflowStateManagerImpl

All Implemented Interfaces:

WorkflowStateManager, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Service("blWorkflowStateManager")
public class WorkflowStateManagerImpl
extends Object
implements org.springframework.context.ApplicationContextAware, WorkflowStateManager

Author:

Jeff Fischer

See Also:

• WorkflowStateManager

Field Summary

Fields

Modifier and Type	Field	Description
protected com.broadleafcommerce.enterprise.common.extension.enterprise.WorkflowStateManagerExtensionManager	extensionManager

Constructor Summary

Constructors

Constructor	Description
WorkflowStateManagerImpl()

Method Summary

Modifier and Type	Method	Description
Boolean	addRollback()
void	addSandBoxCollectionMemberBatchFetch(String key, Map<Serializable,List> members)	Add a list of batch fetch members to a thread local cache.
void	addTransactionBoundCloneLibraryMember(WorkflowCloneLibrary item, TransactionBoundOperationType operationType)
void	clearSandBoxCollectionMemberBatchFetch()	Remove any previously cache batch fetch results from threadlocal.
Boolean	dontPersistEntityItem()	Retrieve the state established by WorkflowStateManager.startDontPersistEntityItemState().
void	endAddState()
void	endAutoPromotionState()	Promotion activities after this call will resume normal workflow steps.
void	endCascadeWorkflowItem()
void	endCausedBy()	Operations performed after this call are no longer understood be have been prompted by this WorkflowSandBoxItem
void	endConstrainFilterGroups()	No longer constrain FilterEnabler instances based on groupNames.
void	endDontPersistEntityItemState()	Any admin operation performed after this call resume normal EntityItem persistence behavior.
void	endEntityPersistState()	End the state in which the promoted WorkflowSandBoxItem id is stored on the request.
void	endHardDeleteState()	Any EntityManager.remove(Object) operation for sandboxable entities will resume normal operation, which is to soft delete (i.e. set sandBoxArchived state to true)
void	endIgnoreArchiveForRevert()	Entity archival operations that are part of a revert will resume normal operation.
void	endIgnoreFiltersState()	Any operations performed after this call will cause FilterEnabler instances to resume normal operation.
void	endIgnorePendingDeploymentsOnEntitySave()
void	endIgnoreUpdateInsertState()	Entity inserts will resume automatic updates of sandboxable associations to the original id
void	endIncludeSandBoxInheritance()	Resume normal operation for including sandbox inheritance, which is to pass true to SandBox.getSandBoxIdsForUpwardHierarchy(boolean).
void	endInhibitDeleteCascade()
void	endOriginalSandBoxState()	Any operation performed after this call will no longer be associated with originating information.
void	endPromoteState()	Any operation performed after this call will no longer be understood to be part of a PromotionStrategy.promoteSandBoxItemChanges(Long, Long[], boolean, String, String, boolean) call.
void	endPropagationOriginalIdCache()
void	endRejectState()	Any operation performed after this call will no longer be understood to be part of a RejectionStrategy.rejectSandBoxItemChanges(Long[], String) call.
void	endReplayState()	Any operation performed after this call will no longer be understood to be part of a AbstractWorkflowManager.replayChange(Long, Long, WorkflowSandBoxItem, boolean, boolean, boolean, String) call.
void	endReversePropertyValue()	Resume normal Property persistence behavior where the persistence package property value is used directly for the persisted value.
void	endRevertState()	Any operation performed after this call will no longer be understood to be part of a RevertWorkflowManager.revertSandBoxItem(com.broadleafcommerce.enterprise.workflow.domain.WorkflowSandBoxItem, com.broadleafcommerce.enterprise.workflow.service.type.SandBoxOperationType) call.
void	endRollbackState()
void	endSandBoxStateFetchCache()	Loaded entities (com.broadleafcommerce.enterprise.workflow.persistence.event.listener.LoadWorker will no longer be cached.
void	endSyncState()	Any operation performed after this call will no longer be understood to be part of a SyncWorkflowManager.syncChanges(Long, Long) call.
void	endVetoProductionUpdate()
void	endVetoSandBoxUpdate()
Boolean	getAutoPromotion()	Retrieve the state established by WorkflowStateManager.startAutoPromotionState()
Long	getCascadeWorkflowItemId()
Long	getCausedBy()	Retrieve the state established by WorkflowStateManager.startCausedBy(Long)
List<String>	getConstrainedFilterGroups()	Retrieve the state established by WorkflowStateManager.startConstrainFilterGroups(java.util.List)
protected <T> T	getContextObject(String key, Class<?> T)
Long	getCreationSandBox()	Retrieve the state established by WorkflowStateManager.startReplayState(Long)
Long	getEntityPersistSandBoxItem()	Retrieve the id for the WorkflowSandBoxItem promoted recently in this request.
String	getEntityPrimaryKeyRollback()
String	getGroupDescriptionRollback()
Boolean	getHardDeleteState()	Retrieve the state established by WorkflowStateManager.startHardDeleteState()
Boolean	getIgnoreArchiveForRevert()	Retrieve the state established by WorkflowStateManager.startIgnoreArchiveForRevert()
Boolean	getIgnoreCloning()	Retrieve the state established by #startIgnoreCloning()
Boolean	getIgnoreFilters()	Retrieve the state established by WorkflowStateManager.startIgnoreFiltersState()
Boolean	getIgnorePendingDeploymentsOnEntitySave()
Boolean	getIgnoreUpdateInsertState()	Retrieve the state established by WorkflowStateManager.startIgnoreUpdateInsertState()
Class	getIgnoreUpdateInsertStateClass()
Boolean	getIncludeSandboxInheritance()	Retrieve the state established by WorkflowStateManager.startIncludeSandBoxInheritance(Boolean).
WorkflowSandBoxItem	getItemContainerOverride()
List<String>	getLoadedEntities()	Retrieve a list of sandbox entities that have been loaded in this request.
Long	getOriginalSandBox()	Retrieve the state established by WorkflowStateManager.startOriginalSandBoxState(Long, SandBoxOperationOrigin, Long, String)
Long	getOriginalWorkflowItemId()	Retrieve the state established by WorkflowStateManager.startOriginalSandBoxState(Long, SandBoxOperationOrigin, Long, String)
Map<String,String>	getProdAddedEntities()
String	getPromotionMessage()	Retrieve the state established by WorkflowStateManager.startOriginalSandBoxState(Long, SandBoxOperationOrigin, Long, String)
Map<String,Set<Long>>	getPropagationOriginalIdCache()
Boolean	getReversePropertyValues()	Retrieve the state established by WorkflowStateManager.startReversePropertyValue()
Map<Serializable,List>	getSandBoxCollectionMemberBatchFetch(String key)	Retrieve any previously batch fetched member match the cache key.
SandBoxOperationOrigin	getSandBoxOperationOrigin()	Retrieve the state established by WorkflowStateManager.startOriginalSandBoxState(Long, SandBoxOperationOrigin, Long, String)
SandBoxOperationType	getSandBoxOperationType()	Retrieve the operation type established by WorkflowStateManager.startRevertState(com.broadleafcommerce.enterprise.workflow.service.type.SandBoxOperationType).
static org.broadleafcommerce.common.sandbox.service.SandBoxService	getSandBoxService()
Map<String,Object>	getSandBoxStateFetchCache()	Retrieve the state established by WorkflowStateManager.startSandBoxStateFetchCache()
byte[]	getSerializedRollback()
Boolean	getVetoProductionUpdate()
Boolean	getVetoSandBoxUpdate()
static WorkflowStateManager	getWorkflowStateManager()
Boolean	isAddControlFlow()
Boolean	isConditionallyIgnoreFilterState()	Determine whether or not the flag has been set - generally used by components that need to determine whether or not to call WorkflowStateManager.startIgnoreFiltersState()
Boolean	isEntityPersistActive()	Whether or not a WorkflowSandBoxItem was promoted in this thread.
Boolean	isInhibitDeleteCascade()
Boolean	isProdAdminFilter()	Retrieve the state established by #startProductionAdminFilterState()
Boolean	isPromotion()	Retrieve the state established by WorkflowStateManager.startPromoteState()
Boolean	isReject()	Retrieve the state established by WorkflowStateManager.startRejectState()
Boolean	isSync()	Retrieve the state established by WorkflowStateManager.startSyncState()
Boolean	isWorkflowManagerControlFlow()	Whether or not the current request thread is part of a call to WorkflowManager.
List<TransactionBoundOperationPackage>	removeTransactionBoundCloneLibraryMembers()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setEntityPersistSandBoxItem(Long sandBoxItem)	Set the primary key value of the WorkflowSandBoxItem that was just promoted on the thread.
void	setItemContainerOverride(WorkflowSandBoxItem container)	Sets a container item that all other created WorkflowSandBoxItems within the current thread should fall under
void	startAddState()
void	startAutoPromotionState()	Promotion activities performed after this call will ignore workflow steps and cause deployment to production for the change to happen immediately.
void	startCascadeWorkflowItem(Long cascadeWorkflowItemId)
void	startCausedBy(Long workflowSandBoxItemId)	For auto rejects, operations performed after this call are understood be have been prompted by this WorkflowSandBoxItem
void	startConditionallyIgnoreFiltersState()	Intended to set a flag on the thread that another component in the control flow can utilize to determine whether or not WorkflowStateManager.startIgnoreFiltersState() should be called.
void	startConstrainFilterGroups(List<String> groupNames)	Any operations performed after this call will cause FilterEnabler instances whose name matches one of the groupNames to be available for enabling.
void	startDontPersistEntityItemState()	Any admin operation performed after this call will not cause an EntityItem to be persisted.
void	startEntityPersistState()	Establish the state in which the WorkflowSandBoxItem id created during a promotion can be stored for the request.
void	startHardDeleteState()	Any EntityManager.remove(Object) operation for sandboxable entities performed after this call will be hard deleted from the persistence store, rather than soft deleted.
void	startIgnoreArchiveForRevert()	Any entity archival operation that is part of a revert will be ignored after this call.
void	startIgnoreFiltersState()	Any operations performed after this call will cause FilterEnabler instances in Enterprise to not enable their associated Hibernate filters.
void	startIgnorePendingDeploymentsOnEntitySave()
void	startIgnoreUpdateInsertState()	Any entity insert will ignore automatic updates of sandboxable associations to the original id after this call
void	startIgnoreUpdateInsertState(Class clazz)
void	startIncludeSandBoxInheritance(Boolean includeSandBoxInheritance)	Some operations performed after this call will utilize the includeSandBoxInheritance param for the boolean parameter to SandBox.getSandBoxIdsForUpwardHierarchy(boolean).
void	startInhibitDeleteCascade()
void	startLoadedEntitiesState()	Any Hibernate load entity operation that occurs after this call will have the identity of the loaded entity stored for the request if the loaded entity is different than the requested entity.
void	startOriginalSandBoxState(Long originalSandBox, SandBoxOperationOrigin origin, Long originWorkflowItemId, String msg)	Any operation performed after this call will be understood to have originated from this information.
void	startProdAddedEntitiesState()
void	startPromoteState()	Any operation performed after this call will be understood to be part of a PromotionStrategy.promoteSandBoxItemChanges(Long, Long[], boolean, String, String, boolean) call.
void	startPropagationOriginalIdCache()
void	startRejectState()	Any operation performed after this call will be understood to be part of a RejectionStrategy.rejectSandBoxItemChanges(Long[], String) call.
void	startReplayState(Long creationSandBoxId)	Any operation performed after this call will be understood to be part of a AbstractWorkflowManager.replayChange(Long, Long, WorkflowSandBoxItem, boolean, boolean, boolean, String) call.
void	startReversePropertyValue()	Any Property persistence operation performed after this call will cause the value of the property to be set to the previously most recent property value for the same change from another sandbox, or to the persistence package property original value if no other change is available.
void	startRevertState(SandBoxOperationType operationType)	Any operation performed after this call will be understood to be part of a RevertWorkflowManager.revertSandBoxItem(com.broadleafcommerce.enterprise.workflow.domain.WorkflowSandBoxItem, com.broadleafcommerce.enterprise.workflow.service.type.SandBoxOperationType) call.
void	startRollbackState(byte[] serializedState, String groupDescription, String primaryKey)
void	startSandBoxStateFetchCache()	Any loaded entity (com.broadleafcommerce.enterprise.workflow.persistence.event.listener.LoadWorker will be cached during fetch requests after this call.
void	startSyncState()	Any operation performed after this call will be understood to be part of a SyncWorkflowManager.syncChanges(Long, Long)} call.
void	startVetoProductionUpdate()
void	startVetoSandBoxUpdate()
Boolean	useSandBoxStateInProduction()

Methods inherited from class java.lang.Object

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

Field Details

extensionManager

protected com.broadleafcommerce.enterprise.common.extension.enterprise.WorkflowStateManagerExtensionManager extensionManager

Constructor Details

WorkflowStateManagerImpl

public WorkflowStateManagerImpl()

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

startIgnoreUpdateInsertState

public void startIgnoreUpdateInsertState()

Description copied from interface: WorkflowStateManager

Any entity insert will ignore automatic updates of sandboxable associations to the original id after this call

Specified by:

startIgnoreUpdateInsertState in interface WorkflowStateManager

startIgnoreUpdateInsertState

public void startIgnoreUpdateInsertState(Class clazz)

Specified by:

startIgnoreUpdateInsertState in interface WorkflowStateManager

endIgnoreUpdateInsertState

public void endIgnoreUpdateInsertState()

Description copied from interface: WorkflowStateManager

Entity inserts will resume automatic updates of sandboxable associations to the original id

Specified by:

endIgnoreUpdateInsertState in interface WorkflowStateManager

startIgnoreFiltersState

public void startIgnoreFiltersState()

Description copied from interface: WorkflowStateManager

Any operations performed after this call will cause FilterEnabler instances in Enterprise to not enable their associated Hibernate filters.

Specified by:

startIgnoreFiltersState in interface WorkflowStateManager

startConditionallyIgnoreFiltersState

public void startConditionallyIgnoreFiltersState()

Description copied from interface: WorkflowStateManager

Intended to set a flag on the thread that another component in the control flow can utilize to determine whether or not WorkflowStateManager.startIgnoreFiltersState() should be called.

Specified by:

startConditionallyIgnoreFiltersState in interface WorkflowStateManager

endIgnoreFiltersState

public void endIgnoreFiltersState()

Description copied from interface: WorkflowStateManager

Any operations performed after this call will cause FilterEnabler instances to resume normal operation.

Specified by:

endIgnoreFiltersState in interface WorkflowStateManager

startSandBoxStateFetchCache

public void startSandBoxStateFetchCache()

Description copied from interface: WorkflowStateManager

Any loaded entity (com.broadleafcommerce.enterprise.workflow.persistence.event.listener.LoadWorker will be cached during fetch requests after this call.

Specified by:

startSandBoxStateFetchCache in interface WorkflowStateManager

endSandBoxStateFetchCache

public void endSandBoxStateFetchCache()

Description copied from interface: WorkflowStateManager

Loaded entities (com.broadleafcommerce.enterprise.workflow.persistence.event.listener.LoadWorker will no longer be cached.

Specified by:

endSandBoxStateFetchCache in interface WorkflowStateManager

startPropagationOriginalIdCache

public void startPropagationOriginalIdCache()

Specified by:

startPropagationOriginalIdCache in interface WorkflowStateManager

endPropagationOriginalIdCache

public void endPropagationOriginalIdCache()

Specified by:

endPropagationOriginalIdCache in interface WorkflowStateManager

startIgnoreArchiveForRevert

public void startIgnoreArchiveForRevert()

Description copied from interface: WorkflowStateManager

Any entity archival operation that is part of a revert will be ignored after this call.

Specified by:

startIgnoreArchiveForRevert in interface WorkflowStateManager

endIgnoreArchiveForRevert

public void endIgnoreArchiveForRevert()

Description copied from interface: WorkflowStateManager

Entity archival operations that are part of a revert will resume normal operation.

Specified by:

endIgnoreArchiveForRevert in interface WorkflowStateManager

startInhibitDeleteCascade

public void startInhibitDeleteCascade()

Specified by:

startInhibitDeleteCascade in interface WorkflowStateManager

endInhibitDeleteCascade

public void endInhibitDeleteCascade()

Specified by:

endInhibitDeleteCascade in interface WorkflowStateManager

startVetoProductionUpdate

public void startVetoProductionUpdate()

Specified by:

startVetoProductionUpdate in interface WorkflowStateManager

endVetoProductionUpdate

public void endVetoProductionUpdate()

Specified by:

endVetoProductionUpdate in interface WorkflowStateManager

startVetoSandBoxUpdate

public void startVetoSandBoxUpdate()

Specified by:

startVetoSandBoxUpdate in interface WorkflowStateManager

endVetoSandBoxUpdate

public void endVetoSandBoxUpdate()

Specified by:

endVetoSandBoxUpdate in interface WorkflowStateManager

startCausedBy

public void startCausedBy(Long workflowSandBoxItemId)

Description copied from interface: WorkflowStateManager

For auto rejects, operations performed after this call are understood be have been prompted by this WorkflowSandBoxItem

Specified by:

startCausedBy in interface WorkflowStateManager

Parameters:

workflowSandBoxItemId - the primary key value

endCausedBy

public void endCausedBy()

Description copied from interface: WorkflowStateManager

Operations performed after this call are no longer understood be have been prompted by this WorkflowSandBoxItem

Specified by:

endCausedBy in interface WorkflowStateManager

startAutoPromotionState

public void startAutoPromotionState()

Description copied from interface: WorkflowStateManager

Promotion activities performed after this call will ignore workflow steps and cause deployment to production for the change to happen immediately.

Specified by:

startAutoPromotionState in interface WorkflowStateManager

endAutoPromotionState

public void endAutoPromotionState()

Description copied from interface: WorkflowStateManager

Promotion activities after this call will resume normal workflow steps.

Specified by:

endAutoPromotionState in interface WorkflowStateManager

startEntityPersistState

public void startEntityPersistState()

Description copied from interface: WorkflowStateManager

Establish the state in which the WorkflowSandBoxItem id created during a promotion can be stored for the request. Defaults to -1L.

Specified by:

startEntityPersistState in interface WorkflowStateManager

endEntityPersistState

public void endEntityPersistState()

Description copied from interface: WorkflowStateManager

End the state in which the promoted WorkflowSandBoxItem id is stored on the request.

Specified by:

endEntityPersistState in interface WorkflowStateManager

startConstrainFilterGroups

public void startConstrainFilterGroups(List<String> groupNames)

Description copied from interface: WorkflowStateManager

Any operations performed after this call will cause FilterEnabler instances whose name matches one of the groupNames to be available for enabling. Non-matches will be disabled.

Specified by:

startConstrainFilterGroups in interface WorkflowStateManager

Parameters:

groupNames - the names of qualified FilterEnabler instances

endConstrainFilterGroups

public void endConstrainFilterGroups()

Description copied from interface: WorkflowStateManager

No longer constrain FilterEnabler instances based on groupNames.

Specified by:

endConstrainFilterGroups in interface WorkflowStateManager

startRejectState

public void startRejectState()

Description copied from interface: WorkflowStateManager

Any operation performed after this call will be understood to be part of a RejectionStrategy.rejectSandBoxItemChanges(Long[], String) call.

Specified by:

startRejectState in interface WorkflowStateManager

endRejectState

public void endRejectState()

Description copied from interface: WorkflowStateManager

Any operation performed after this call will no longer be understood to be part of a RejectionStrategy.rejectSandBoxItemChanges(Long[], String) call.

Specified by:

endRejectState in interface WorkflowStateManager

startPromoteState

public void startPromoteState()

Description copied from interface: WorkflowStateManager

Any operation performed after this call will be understood to be part of a PromotionStrategy.promoteSandBoxItemChanges(Long, Long[], boolean, String, String, boolean) call.

Specified by:

startPromoteState in interface WorkflowStateManager

startAddState

public void startAddState()

Specified by:

startAddState in interface WorkflowStateManager

endAddState

public void endAddState()

Specified by:

endAddState in interface WorkflowStateManager

endPromoteState

public void endPromoteState()

Description copied from interface: WorkflowStateManager

Any operation performed after this call will no longer be understood to be part of a PromotionStrategy.promoteSandBoxItemChanges(Long, Long[], boolean, String, String, boolean) call.

Specified by:

endPromoteState in interface WorkflowStateManager

startSyncState

public void startSyncState()

Description copied from interface: WorkflowStateManager

Any operation performed after this call will be understood to be part of a SyncWorkflowManager.syncChanges(Long, Long)} call.

Specified by:

startSyncState in interface WorkflowStateManager

endSyncState

public void endSyncState()

Description copied from interface: WorkflowStateManager

Any operation performed after this call will no longer be understood to be part of a SyncWorkflowManager.syncChanges(Long, Long) call.

Specified by:

endSyncState in interface WorkflowStateManager

startReplayState

public void startReplayState(Long creationSandBoxId)

Description copied from interface: WorkflowStateManager

Any operation performed after this call will be understood to be part of a AbstractWorkflowManager.replayChange(Long, Long, WorkflowSandBoxItem, boolean, boolean, boolean, String) call.

Specified by:

startReplayState in interface WorkflowStateManager

endReplayState

public void endReplayState()

Description copied from interface: WorkflowStateManager

Any operation performed after this call will no longer be understood to be part of a AbstractWorkflowManager.replayChange(Long, Long, WorkflowSandBoxItem, boolean, boolean, boolean, String) call.

Specified by:

endReplayState in interface WorkflowStateManager

startIncludeSandBoxInheritance

public void startIncludeSandBoxInheritance(Boolean includeSandBoxInheritance)

Description copied from interface: WorkflowStateManager

Some operations performed after this call will utilize the includeSandBoxInheritance param for the boolean parameter to SandBox.getSandBoxIdsForUpwardHierarchy(boolean).

Specified by:

startIncludeSandBoxInheritance in interface WorkflowStateManager

Parameters:

includeSandBoxInheritance - whether or not all parent sandboxes, in addition to the current sandbox, should be used

endIncludeSandBoxInheritance

public void endIncludeSandBoxInheritance()

Description copied from interface: WorkflowStateManager

Resume normal operation for including sandbox inheritance, which is to pass true to SandBox.getSandBoxIdsForUpwardHierarchy(boolean).

Specified by:

endIncludeSandBoxInheritance in interface WorkflowStateManager

startOriginalSandBoxState

public void startOriginalSandBoxState(Long originalSandBox,
 SandBoxOperationOrigin origin,
 Long originWorkflowItemId,
 String msg)

Description copied from interface: WorkflowStateManager

Any operation performed after this call will be understood to have originated from this information.

Specified by:

startOriginalSandBoxState in interface WorkflowStateManager

Parameters:

originalSandBox - the sandbox that contained the original change

origin - the type of change operation

originWorkflowItemId - the original change itself

msg - the message with the original change

endOriginalSandBoxState

public void endOriginalSandBoxState()

Description copied from interface: WorkflowStateManager

Any operation performed after this call will no longer be associated with originating information.

Specified by:

endOriginalSandBoxState in interface WorkflowStateManager

startCascadeWorkflowItem

public void startCascadeWorkflowItem(Long cascadeWorkflowItemId)

Specified by:

startCascadeWorkflowItem in interface WorkflowStateManager

endCascadeWorkflowItem

public void endCascadeWorkflowItem()

Specified by:

endCascadeWorkflowItem in interface WorkflowStateManager

getCascadeWorkflowItemId

public Long getCascadeWorkflowItemId()

Specified by:

getCascadeWorkflowItemId in interface WorkflowStateManager

startLoadedEntitiesState

public void startLoadedEntitiesState()

Description copied from interface: WorkflowStateManager

Any Hibernate load entity operation that occurs after this call will have the identity of the loaded entity stored for the request if the loaded entity is different than the requested entity. This can occur when a sandbox version of an entity exists for a requested production record.

Specified by:

startLoadedEntitiesState in interface WorkflowStateManager

startProdAddedEntitiesState

public void startProdAddedEntitiesState()

Specified by:

startProdAddedEntitiesState in interface WorkflowStateManager

startRevertState

public void startRevertState(SandBoxOperationType operationType)

Description copied from interface: WorkflowStateManager

Any operation performed after this call will be understood to be part of a RevertWorkflowManager.revertSandBoxItem(com.broadleafcommerce.enterprise.workflow.domain.WorkflowSandBoxItem, com.broadleafcommerce.enterprise.workflow.service.type.SandBoxOperationType) call.

Specified by:

startRevertState in interface WorkflowStateManager

Parameters:

operationType - the type of revert

startRollbackState

public void startRollbackState(byte[] serializedState,
 String groupDescription,
 String primaryKey)

Specified by:

startRollbackState in interface WorkflowStateManager

endRollbackState

public void endRollbackState()

Specified by:

endRollbackState in interface WorkflowStateManager

endRevertState

public void endRevertState()

Description copied from interface: WorkflowStateManager

Any operation performed after this call will no longer be understood to be part of a RevertWorkflowManager.revertSandBoxItem(com.broadleafcommerce.enterprise.workflow.domain.WorkflowSandBoxItem, com.broadleafcommerce.enterprise.workflow.service.type.SandBoxOperationType) call.

Specified by:

endRevertState in interface WorkflowStateManager

startDontPersistEntityItemState

public void startDontPersistEntityItemState()

Description copied from interface: WorkflowStateManager

Any admin operation performed after this call will not cause an EntityItem to be persisted.

Specified by:

startDontPersistEntityItemState in interface WorkflowStateManager

startReversePropertyValue

public void startReversePropertyValue()

Description copied from interface: WorkflowStateManager

Any Property persistence operation performed after this call will cause the value of the property to be set to the previously most recent property value for the same change from another sandbox, or to the persistence package property original value if no other change is available. This is primarily used when multiple users have made changes to the same property and one of those changes is being rejected from the approval sandbox.

Specified by:

startReversePropertyValue in interface WorkflowStateManager

endReversePropertyValue

public void endReversePropertyValue()

Description copied from interface: WorkflowStateManager

Resume normal Property persistence behavior where the persistence package property value is used directly for the persisted value.

Specified by:

endReversePropertyValue in interface WorkflowStateManager

startHardDeleteState

public void startHardDeleteState()

Description copied from interface: WorkflowStateManager

Any EntityManager.remove(Object) operation for sandboxable entities performed after this call will be hard deleted from the persistence store, rather than soft deleted.

Specified by:

startHardDeleteState in interface WorkflowStateManager

endHardDeleteState

public void endHardDeleteState()

Description copied from interface: WorkflowStateManager

Any EntityManager.remove(Object) operation for sandboxable entities will resume normal operation, which is to soft delete (i.e. set sandBoxArchived state to true)

Specified by:

endHardDeleteState in interface WorkflowStateManager

endDontPersistEntityItemState

public void endDontPersistEntityItemState()

Description copied from interface: WorkflowStateManager

Any admin operation performed after this call resume normal EntityItem persistence behavior.

Specified by:

endDontPersistEntityItemState in interface WorkflowStateManager

getContextObject

protected <T> T getContextObject(String key,
 Class<?> T)

getSandBoxOperationType

public SandBoxOperationType getSandBoxOperationType()

Description copied from interface: WorkflowStateManager

Retrieve the operation type established by WorkflowStateManager.startRevertState(com.broadleafcommerce.enterprise.workflow.service.type.SandBoxOperationType).

Specified by:

getSandBoxOperationType in interface WorkflowStateManager

Returns:

the operation type

getCausedBy

public Long getCausedBy()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startCausedBy(Long)

Specified by:

getCausedBy in interface WorkflowStateManager

Returns:

the id for the WorkflowSandBoxItem that prompted an auto reject

dontPersistEntityItem

public Boolean dontPersistEntityItem()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startDontPersistEntityItemState().

Specified by:

dontPersistEntityItem in interface WorkflowStateManager

Returns:

entity item persistence state

getAutoPromotion

public Boolean getAutoPromotion()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startAutoPromotionState()

Specified by:

getAutoPromotion in interface WorkflowStateManager

Returns:

whether or not changes should be immediately deployed to production without workflow steps

getHardDeleteState

public Boolean getHardDeleteState()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startHardDeleteState()

Specified by:

getHardDeleteState in interface WorkflowStateManager

Returns:

whether or not entities should be hard deleted from the persistence store

getIgnoreArchiveForRevert

public Boolean getIgnoreArchiveForRevert()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startIgnoreArchiveForRevert()

Specified by:

getIgnoreArchiveForRevert in interface WorkflowStateManager

Returns:

whether or not to archive an entity on revert

getIgnoreUpdateInsertState

public Boolean getIgnoreUpdateInsertState()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startIgnoreUpdateInsertState()

Specified by:

getIgnoreUpdateInsertState in interface WorkflowStateManager

Returns:

whether or not to automatically update sandboxable associations to the original id during an insert

getIgnoreUpdateInsertStateClass

public Class getIgnoreUpdateInsertStateClass()

Specified by:

getIgnoreUpdateInsertStateClass in interface WorkflowStateManager

getVetoProductionUpdate

public Boolean getVetoProductionUpdate()

Specified by:

getVetoProductionUpdate in interface WorkflowStateManager

getVetoSandBoxUpdate

public Boolean getVetoSandBoxUpdate()

Specified by:

getVetoSandBoxUpdate in interface WorkflowStateManager

getIgnoreCloning

public Boolean getIgnoreCloning()

Description copied from interface: WorkflowStateManager

Retrieve the state established by #startIgnoreCloning()

Specified by:

getIgnoreCloning in interface WorkflowStateManager

Returns:

whether or not to allow clone generation as the result of a persistence operation

addRollback

public Boolean addRollback()

Specified by:

addRollback in interface WorkflowStateManager

Returns:

getSerializedRollback

public byte[] getSerializedRollback()

Specified by:

getSerializedRollback in interface WorkflowStateManager

Returns:

getGroupDescriptionRollback

public String getGroupDescriptionRollback()

Specified by:

getGroupDescriptionRollback in interface WorkflowStateManager

Returns:

getEntityPrimaryKeyRollback

public String getEntityPrimaryKeyRollback()

Specified by:

getEntityPrimaryKeyRollback in interface WorkflowStateManager

Returns:

getIncludeSandboxInheritance

public Boolean getIncludeSandboxInheritance()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startIncludeSandBoxInheritance(Boolean). Defaults to true.

Specified by:

getIncludeSandboxInheritance in interface WorkflowStateManager

Returns:

whether or not all parent sandboxes, in addition to the current sandbox, should be used

getLoadedEntities

public List<String> getLoadedEntities()

Description copied from interface: WorkflowStateManager

Retrieve a list of sandbox entities that have been loaded in this request.

Specified by:

getLoadedEntities in interface WorkflowStateManager

Returns:

sandbox entities that have been loaded in this request.

See Also:

• WorkflowStateManager.startLoadedEntitiesState()

getProdAddedEntities

public Map<String,String> getProdAddedEntities()

Specified by:

getProdAddedEntities in interface WorkflowStateManager

addTransactionBoundCloneLibraryMember

public void addTransactionBoundCloneLibraryMember(WorkflowCloneLibrary item,
 TransactionBoundOperationType operationType)

Specified by:

addTransactionBoundCloneLibraryMember in interface WorkflowStateManager

addSandBoxCollectionMemberBatchFetch

public void addSandBoxCollectionMemberBatchFetch(String key,
 Map<Serializable,List> members)

Description copied from interface: WorkflowStateManager

Add a list of batch fetch members to a thread local cache. See EnterpriseCollectionDao.batchFetchSandBoxCollectionMembers(List, SandBoxCollectionHelper) for more information.

Specified by:

addSandBoxCollectionMemberBatchFetch in interface WorkflowStateManager

Parameters:

key - the key describing the batch fetch collection query. See SandBoxCollectionHelper.getCacheKey().

members - the cache results of the batch fetch

getSandBoxCollectionMemberBatchFetch

public Map<Serializable,List> getSandBoxCollectionMemberBatchFetch(String key)

Description copied from interface: WorkflowStateManager

Retrieve any previously batch fetched member match the cache key. See SandBoxCollectionHelper.getCacheKey().

Specified by:

getSandBoxCollectionMemberBatchFetch in interface WorkflowStateManager

Parameters:

key - the key describing the batch fetch collection query. See SandBoxCollectionHelper.getCacheKey().

Returns:

the cached results of the batch fetch

clearSandBoxCollectionMemberBatchFetch

public void clearSandBoxCollectionMemberBatchFetch()

Description copied from interface: WorkflowStateManager

Remove any previously cache batch fetch results from threadlocal.

Specified by:

clearSandBoxCollectionMemberBatchFetch in interface WorkflowStateManager

removeTransactionBoundCloneLibraryMembers

public List<TransactionBoundOperationPackage> removeTransactionBoundCloneLibraryMembers()

Specified by:

removeTransactionBoundCloneLibraryMembers in interface WorkflowStateManager

getConstrainedFilterGroups

public List<String> getConstrainedFilterGroups()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startConstrainFilterGroups(java.util.List)

Specified by:

getConstrainedFilterGroups in interface WorkflowStateManager

Returns:

the list of FilterEnabler names to restrict by

getReversePropertyValues

public Boolean getReversePropertyValues()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startReversePropertyValue()

Specified by:

getReversePropertyValues in interface WorkflowStateManager

Returns:

whether or not Property persistence values should be altered for reject.

isPromotion

public Boolean isPromotion()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startPromoteState()

Specified by:

isPromotion in interface WorkflowStateManager

Returns:

whether or not this is a promotion

isReject

public Boolean isReject()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startRejectState()

Specified by:

isReject in interface WorkflowStateManager

Returns:

is this a reject

isProdAdminFilter

public Boolean isProdAdminFilter()

Description copied from interface: WorkflowStateManager

Retrieve the state established by #startProductionAdminFilterState()

Specified by:

isProdAdminFilter in interface WorkflowStateManager

Returns:

whether or not to filter for production records, rather than sandbox records

isSync

public Boolean isSync()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startSyncState()

Specified by:

isSync in interface WorkflowStateManager

Returns:

is this a sync

getCreationSandBox

public Long getCreationSandBox()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startReplayState(Long)

Specified by:

getCreationSandBox in interface WorkflowStateManager

Returns:

sandbox id

getOriginalSandBox

public Long getOriginalSandBox()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startOriginalSandBoxState(Long, SandBoxOperationOrigin, Long, String)

Specified by:

getOriginalSandBox in interface WorkflowStateManager

Returns:

the sandbox id

getSandBoxOperationOrigin

public SandBoxOperationOrigin getSandBoxOperationOrigin()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startOriginalSandBoxState(Long, SandBoxOperationOrigin, Long, String)

Specified by:

getSandBoxOperationOrigin in interface WorkflowStateManager

Returns:

the origin

getOriginalWorkflowItemId

public Long getOriginalWorkflowItemId()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startOriginalSandBoxState(Long, SandBoxOperationOrigin, Long, String)

Specified by:

getOriginalWorkflowItemId in interface WorkflowStateManager

Returns:

the primary key value

getPromotionMessage

public String getPromotionMessage()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startOriginalSandBoxState(Long, SandBoxOperationOrigin, Long, String)

Specified by:

getPromotionMessage in interface WorkflowStateManager

Returns:

the message

getIgnoreFilters

public Boolean getIgnoreFilters()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startIgnoreFiltersState()

Specified by:

getIgnoreFilters in interface WorkflowStateManager

Returns:

whether or not to ignore FilterEnabler instances

isWorkflowManagerControlFlow

public Boolean isWorkflowManagerControlFlow()

Description copied from interface: WorkflowStateManager

Whether or not the current request thread is part of a call to WorkflowManager. This includes reject, promote, sync and revert.

Specified by:

isWorkflowManagerControlFlow in interface WorkflowStateManager

Returns:

whether or not the current thread is a WorkflowManager call.

isConditionallyIgnoreFilterState

public Boolean isConditionallyIgnoreFilterState()

Description copied from interface: WorkflowStateManager

Determine whether or not the flag has been set - generally used by components that need to determine whether or not to call WorkflowStateManager.startIgnoreFiltersState()

Specified by:

isConditionallyIgnoreFilterState in interface WorkflowStateManager

Returns:

whether or not the flag has been set

isAddControlFlow

public Boolean isAddControlFlow()

Specified by:

isAddControlFlow in interface WorkflowStateManager

isInhibitDeleteCascade

public Boolean isInhibitDeleteCascade()

Specified by:

isInhibitDeleteCascade in interface WorkflowStateManager

getEntityPersistSandBoxItem

public Long getEntityPersistSandBoxItem()

Description copied from interface: WorkflowStateManager

Retrieve the id for the WorkflowSandBoxItem promoted recently in this request.

Specified by:

getEntityPersistSandBoxItem in interface WorkflowStateManager

Returns:

the primary key value of the promoted item

getSandBoxStateFetchCache

public Map<String,Object> getSandBoxStateFetchCache()

Description copied from interface: WorkflowStateManager

Retrieve the state established by WorkflowStateManager.startSandBoxStateFetchCache()

Specified by:

getSandBoxStateFetchCache in interface WorkflowStateManager

Returns:

the cache of sandboxable entities that have been loaded during an admin fetch operation

getPropagationOriginalIdCache

public Map<String,Set<Long>> getPropagationOriginalIdCache()

Specified by:

getPropagationOriginalIdCache in interface WorkflowStateManager

isEntityPersistActive

public Boolean isEntityPersistActive()

Description copied from interface: WorkflowStateManager

Whether or not a WorkflowSandBoxItem was promoted in this thread.

Specified by:

isEntityPersistActive in interface WorkflowStateManager

Returns:

whether or not there was a promotion

setEntityPersistSandBoxItem

public void setEntityPersistSandBoxItem(Long sandBoxItem)

Description copied from interface: WorkflowStateManager

Set the primary key value of the WorkflowSandBoxItem that was just promoted on the thread.

Specified by:

setEntityPersistSandBoxItem in interface WorkflowStateManager

Parameters:

sandBoxItem - the primary key of the promoted item

setItemContainerOverride

public void setItemContainerOverride(WorkflowSandBoxItem container)

Description copied from interface: WorkflowStateManager

Sets a container item that all other created WorkflowSandBoxItems within the current thread should fall under

Specified by:

setItemContainerOverride in interface WorkflowStateManager

getItemContainerOverride

public WorkflowSandBoxItem getItemContainerOverride()

Specified by:

getItemContainerOverride in interface WorkflowStateManager

Returns:

the container item that all other created WorkflowSandBoxItems within the current thread should fall under. All of the created items should have their WorkflowSandBoxItem.setContainer(WorkflowSandBoxItem) set to this

startIgnorePendingDeploymentsOnEntitySave

public void startIgnorePendingDeploymentsOnEntitySave()

Specified by:

startIgnorePendingDeploymentsOnEntitySave in interface WorkflowStateManager

endIgnorePendingDeploymentsOnEntitySave

public void endIgnorePendingDeploymentsOnEntitySave()

Specified by:

endIgnorePendingDeploymentsOnEntitySave in interface WorkflowStateManager

getIgnorePendingDeploymentsOnEntitySave

public Boolean getIgnorePendingDeploymentsOnEntitySave()

Specified by:

getIgnorePendingDeploymentsOnEntitySave in interface WorkflowStateManager

useSandBoxStateInProduction

public Boolean useSandBoxStateInProduction()

Specified by:

useSandBoxStateInProduction in interface WorkflowStateManager

getWorkflowStateManager

public static WorkflowStateManager getWorkflowStateManager()

getSandBoxService

public static org.broadleafcommerce.common.sandbox.service.SandBoxService getSandBoxService()