com.broadleafcommerce.enterprise.workflow.dao

Class WorkflowSandBoxItemDaoImpl

java.lang.Object

com.broadleafcommerce.enterprise.workflow.dao.WorkflowSandBoxItemDaoImpl

All Implemented Interfaces:

WorkflowSandBoxItemDao

@Repository(value="blWorkflowSandBoxItemDao")
public class WorkflowSandBoxItemDaoImpl
extends Object
implements WorkflowSandBoxItemDao

Author:

Jeff Fischer

See Also:

UpdateExecutor, WorkflowSandBoxItemDao

Field Summary

Fields

Modifier and Type	Field and Description
static String	BC_REVERT_SCHEDULED_EVENTS
static String	BC_REVERT_SCHEDULED_ITEMS
static String	BC_UPDATE_ARCHIVE_EMPTY_EVENTS
static String	BC_UPDATE_ARCHIVE_STALE_EVENTS
static String	BC_UPDATE_CLEAR_ITEMS
static String	BC_UPDATE_ORIGINAL_VERSION
static String	BC_UPDATE_PROMOTION_MARKER_ITEMS
static String	BC_UPDATE_RESET_ITEMS_PROMOTION
static String	BC_UPDATE_SCHEDULED_EVENTS
static String	BC_UPDATE_SCHEDULED_ITEMS
static String	BC_UPDATE_TARGET_VERSION
protected javax.persistence.EntityManager	em
protected com.broadleafcommerce.enterprise.common.extension.enterprise.WorkflowSandBoxItemDaoExtensionManager	extensionManager
protected com.broadleafcommerce.enterprise.common.extension.enterprise.WorkflowSandBoxItemDaoQueryExtensionManager	queryExtensionManager
protected com.broadleafcommerce.jobsevents.service.DatabaseSystemEventNode	systemEventNode
protected org.springframework.orm.jpa.JpaTransactionManager	transactionManager
protected VersionDao	versionDao
protected EnterpriseWorkflowLogger	workflowLogger
protected com.broadleafcommerce.enterprise.common.extension.enterprise.AbstractWorkflowManagerExtensionManager	workflowManagerExtensionManager
protected WorkflowStateManager	workflowStateManager

Constructor Summary

Constructors

Constructor and Description
WorkflowSandBoxItemDaoImpl()

Method Summary

Modifier and Type	Method and Description
WorkflowSandBoxItem	addWorkflowSandBoxItem(Long sandBox, Long originalSandBox, Long creationSandBox, Long parentSandBox, SandBoxOperationType operationType, String description, String groupDescription, Long temporaryId, Long originalId, String itemName, SandBoxOperationOrigin operationOrigin, String msg, Long originalWorkflowItemId)
int	archiveAllEmptyEvents()
int	archiveAllEmptyProgressEventsByPromotionMarker() Archive any inprogress WorkflowEvents whose promotionMarker related WorkflowSandBoxItems are all archived and who does not have any completed promotion WorkflowSandBoxItem associated.
int	archiveEmptyEventIfNecessary(Long eventId) Archive any events that have no associated WorkflowSandBoxItem instances
int	archiveEmptyEventWithStatus(Long eventId)
int	archiveEvents(List<Long> eventIds) Updates the archived flag for the given WorkflowEvents to be Y.
int	archiveStaleEventsIfNecessary(Long eventId, Long itemId)
int	clearItems(List<Long> sandBoxItemIds) Remove the WorkflowSandBoxItem.getPromotionMarker() value for the list of sandBoxItemIds.
void	delete(WorkflowSandBoxItem item)
List<Long>	filterWorkflowItemsByClass(Long[] workflowItemIds, String className) Returns a list of workflowSandBoxItem IDs that are a subset of the given workflowItemIds that have an entity class matching the given className
List<Long>	getIdsByPromotionMarker(Long promotionMarker)
boolean	isDeploymentRetryable(long deploymentId) Detect whether or not a deployment can be retried via the admin UI.
boolean	isEventInProgress(List<Long> eventId)
boolean	lockExecution(String key) Attempt to perform an optimistic lock on the key.
WorkflowSandBoxItem	merge(WorkflowSandBoxItem workflowSandBoxItem) Saves the given WorkflowSandBoxItem
int	resetItemsForPromotion(List<Long> sandBoxItemIds, Long eventId) Update the WorkflowSandBoxItem.getPromotionMarker() value with the eventId for the list of sandBoxItemIds.
List<Long>	retrieveAllContainersByCeilingTypeAndId(String ceiling, Long id) Retrieve all container item ids for a given ceiling entity and original id
List<Long>	retrieveAllContainersByCeilingTypeAndId(String ceiling, String itemId) Retrieve all container item ids for a given ceiling entity and original id
List<Long>	retrieveAllContainersByCeilingTypeAndId(String ceiling, String itemId, boolean includeArchived)
List<WorkflowSandBoxItem>	retrieveAllNonContainerSandboxItemsForEntityId(Long entityId, String className, Boolean includeArchived, Long siteId) Retrieves all WorkflowSandBoxItem associated with container instances targeting that id in production
Map<Long,String>	retrieveAuthorNamesForWorkflowItems(Set<Long> workflowItemIds)
List<WorkflowSandBoxItem>	retrieveChildItemsForContainerItems(List<Long> containerIds, Long sandBoxId) Based on a list of WorkflowSandBoxItem ids that are containers (containers are WorkflowSandBoxItem instances that have child items), retrieve all the associated child items.
List<Long>	retrieveContainerSandboxItemsForPromotion(Long sandboxId, String origin) Returns a list of Ids of workflowSandBoxItems that are associated to the given SandBox and SandBox origin that do not have an associated WorkflowSandBoxItem.getPromotionMarker() which would signify that it has been promoted or has an associated failed promotion.
List<EarlyAbortedPromotionCandidate>	retrieveEarlyAbortedInProgressApprovals() Retrieve in progress approvals that appear to have failed before being completely setup.
List<EarlyAbortedPromotionCandidate>	retrieveEarlyAbortedInProgressPromotions() Retrieve in progress promotions that appear to have failed before being completely setup.
List<ChildItem>	retrieveForwardDependentItems(List<Long> sandBoxItemids, Long sandBoxId) Retrieve dependent items
List<String>	retrieveGroupNames(Long sandBox) Find all the unique change group names that currently exist in the sandbox
List<Long>	retrieveItemIdsForEvent(Long eventId)
List<Long>	retrieveItemIdsForEventIncludingArchived(Long eventId)
List<Long>	retrieveItemIdsForEventIncludingArchivedByPromotionMarker(Long eventId)
List<Long>	retrieveItemIdsForEvents(Long[] eventIds)
List<WorkflowSandBoxItem>	retrieveItemsByEntityItemAndChangeType(Long entityItemId, org.broadleafcommerce.openadmin.server.service.type.ChangeType changeType) Look for items for a specific change and change type
WorkflowSandBoxItem	retrieveMostRecentItemBasedOnOriginal(List<Long> ids)
List<ChildItem>	retrieveReverseDependentItems(List<Long> sandBoxItemids, Long sandBoxId) Retrieve dependent items
List<Long>	retrieveSandBoxItemIdsForSandbox(Long sandBox, boolean containerOnly) Retrieve WorkflowSandBoxItem ids in the sandbox
List<Long>	retrieveSandBoxItemIdsWithEventsForSandbox(Long sandBox) Retrieve WorkflowSandBoxItem ids in the sandbox that have a non-archived WorkflowEvent
List<Long>	retrieveSandboxItemsBySandboxOrigin(Long sandboxId, String origin) Returns a list of Ids of workflowSandBoxItems that are associated to the given SandBox and SandBox origin
List<WorkflowSandBoxItem>	retrieveSandboxItemsForEntityId(Long entityId, String className, Boolean includeArchived, Long siteId) Retrieves container instances targeting that id in production
WorkflowSandBoxItem	retrieveWorkflowItemById(Long id)
WorkflowSandBoxItem	retrieveWorkflowItemById(Long id, boolean useCache)
List<WorkflowSandBoxItem>	retrieveWorkflowItemByIds(List<Long> ids, boolean ascending)
List<WorkflowSandBoxItem>	retrieveWorkflowItemByOriginalEntityId(Long id)
List<WorkflowSandBoxItem>	retrieveWorkflowItemByOriginalItemIds(List<Long> ids)
List<WorkflowSandBoxItem>	retrieveWorkflowItemsByGroupName(Long sandBoxId, Long originalSandBoxId, String groupName, boolean isContainer) Retrieve by sandbox and change group name
List<WorkflowSandBoxItem>	retrieveWorkflowItemsByGroupName(Long sandBoxId, String groupName) Retrieve by sandbox and change group name
List<WorkflowSandBoxItem>	retrieveWorkflowItemsByGroupName(Long sandBoxId, String groupName, boolean isContainer) Retrieve by sandbox and change group name
Long	retrieveWorkflowItemsCountByGroupName(Long sandBoxId, String groupName, Long causedBy) Retrieve the count by sandbox and change group name
Long	retrieveWorkflowItemsCountByGroupNameAndType(Long sandBoxId, String groupName, SandBoxOperationType type, Long causedBy) Retrieve the items by sandbox and change group name
List<WorkflowSandBoxItem>	retrieveWorkflowItemsForSync(Long sandBoxId, String groupName, Long inheritedVersion) Retrieve items that need to be synced
WorkflowSandBoxItem	retrieveWorkflowSandBoxItemByCeilingTypeAndItemId(Long currentSandBoxId, String ceil, Long itemId) Retrieve instances based on sandbox, ceiling entity, and entity id
WorkflowSandBoxItem	retrieveWorkflowSandBoxItemByEntityItemId(Long entityItemId) Find by the associated EntityItem
WorkflowSandBoxItem	retrieveWorkflowSandBoxItemBySandboxAndItemId(List<Long> sandBoxIds, Long currentSandBoxId, Long itemId, boolean includeArchived) Retrieve instances based on sandbox and entity item id
WorkflowSandBoxItem	retrieveWorkflowSandBoxItemBySandboxAndItemId(Long currentSandBoxId, Long itemId) Retrieve instances based on sandbox and entity item id
List<WorkflowSandBoxItem>	retrieveWorkflowSandBoxItemsBySandBoxId(Long sandBoxId) Returns a list of workflowSandBoxItems that are associated to the given SandBox
List<WorkflowSandBoxItem>	retrieveWorkflowSandBoxItemsBySandBoxId(Long sandBoxId, boolean containerOnly)
WorkflowSandBoxItem	save(WorkflowSandBoxItem item)
int	setPromotionMarker(List<Long> itemIds, Long eventId)
int	setScheduledEvents(Long eventId, Date scheduledDate)
int	setScheduledItems(List<Long> itemIds, Date scheduledDate) Set the deployment date for one or more items
void	unlockExecution(String key) Attempt to perform an optimistic unlock on the key.
void	unSetScheduledEvents(Long eventId)
void	unSetScheduledItems(List<Long> itemIds)
void	updateItemVersionAndInheritedVersionByGroup(Long sandBoxId, String groupName, Long version, Long inheritedVersion)
void	updateItemVersionByGroup(Long sandBoxId, String groupName, Long version)

Methods inherited from class java.lang.Object

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

Field Detail

BC_UPDATE_SCHEDULED_ITEMS

public static final String BC_UPDATE_SCHEDULED_ITEMS

See Also:

Constant Field Values

BC_UPDATE_TARGET_VERSION

public static final String BC_UPDATE_TARGET_VERSION

See Also:

Constant Field Values

BC_UPDATE_ORIGINAL_VERSION

public static final String BC_UPDATE_ORIGINAL_VERSION

See Also:

Constant Field Values

BC_REVERT_SCHEDULED_ITEMS

public static final String BC_REVERT_SCHEDULED_ITEMS

See Also:

Constant Field Values

BC_UPDATE_SCHEDULED_EVENTS

public static final String BC_UPDATE_SCHEDULED_EVENTS

See Also:

Constant Field Values

BC_REVERT_SCHEDULED_EVENTS

public static final String BC_REVERT_SCHEDULED_EVENTS

See Also:

Constant Field Values

BC_UPDATE_ARCHIVE_EMPTY_EVENTS

public static final String BC_UPDATE_ARCHIVE_EMPTY_EVENTS

See Also:

Constant Field Values

BC_UPDATE_ARCHIVE_STALE_EVENTS

public static final String BC_UPDATE_ARCHIVE_STALE_EVENTS

See Also:

Constant Field Values

BC_UPDATE_RESET_ITEMS_PROMOTION

public static final String BC_UPDATE_RESET_ITEMS_PROMOTION

See Also:

Constant Field Values

BC_UPDATE_CLEAR_ITEMS

public static final String BC_UPDATE_CLEAR_ITEMS

See Also:

Constant Field Values

BC_UPDATE_PROMOTION_MARKER_ITEMS

public static final String BC_UPDATE_PROMOTION_MARKER_ITEMS

See Also:

Constant Field Values

em

protected javax.persistence.EntityManager em

versionDao

protected VersionDao versionDao

workflowStateManager

protected WorkflowStateManager workflowStateManager

extensionManager

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

queryExtensionManager

protected com.broadleafcommerce.enterprise.common.extension.enterprise.WorkflowSandBoxItemDaoQueryExtensionManager queryExtensionManager

systemEventNode

protected com.broadleafcommerce.jobsevents.service.DatabaseSystemEventNode systemEventNode

transactionManager

protected org.springframework.orm.jpa.JpaTransactionManager transactionManager

workflowLogger

protected EnterpriseWorkflowLogger workflowLogger

workflowManagerExtensionManager

protected com.broadleafcommerce.enterprise.common.extension.enterprise.AbstractWorkflowManagerExtensionManager workflowManagerExtensionManager

Constructor Detail

WorkflowSandBoxItemDaoImpl

public WorkflowSandBoxItemDaoImpl()

Method Detail

retrieveWorkflowItemById

public WorkflowSandBoxItem retrieveWorkflowItemById(Long id)

Specified by:

retrieveWorkflowItemById in interface WorkflowSandBoxItemDao

retrieveWorkflowItemById

public WorkflowSandBoxItem retrieveWorkflowItemById(Long id,
                                                    boolean useCache)

Specified by:

retrieveWorkflowItemById in interface WorkflowSandBoxItemDao

filterWorkflowItemsByClass

public List<Long> filterWorkflowItemsByClass(Long[] workflowItemIds,
                                             String className)

Description copied from interface: WorkflowSandBoxItemDao

Returns a list of workflowSandBoxItem IDs that are a subset of the given workflowItemIds that have an entity class matching the given className

Specified by:

filterWorkflowItemsByClass in interface WorkflowSandBoxItemDao

Returns:

the filtered IDs

retrieveWorkflowSandBoxItemsBySandBoxId

public List<WorkflowSandBoxItem> retrieveWorkflowSandBoxItemsBySandBoxId(Long sandBoxId)

Description copied from interface: WorkflowSandBoxItemDao

Returns a list of workflowSandBoxItems that are associated to the given SandBox

Specified by:

retrieveWorkflowSandBoxItemsBySandBoxId in interface WorkflowSandBoxItemDao

Returns:

the list of WorkflowSandBoxItems associated with the given SandBox

retrieveWorkflowSandBoxItemsBySandBoxId

public List<WorkflowSandBoxItem> retrieveWorkflowSandBoxItemsBySandBoxId(Long sandBoxId,
                                                                         boolean containerOnly)

Specified by:

retrieveWorkflowSandBoxItemsBySandBoxId in interface WorkflowSandBoxItemDao

merge

public WorkflowSandBoxItem merge(WorkflowSandBoxItem workflowSandBoxItem)

Description copied from interface: WorkflowSandBoxItemDao

Saves the given WorkflowSandBoxItem

Specified by:

merge in interface WorkflowSandBoxItemDao

Returns:

the merged WorkflowSandBoxItem

retrieveSandboxItemsForEntityId

public List<WorkflowSandBoxItem> retrieveSandboxItemsForEntityId(Long entityId,
                                                                 String className,
                                                                 Boolean includeArchived,
                                                                 Long siteId)

Description copied from interface: WorkflowSandBoxItemDao

Retrieves container instances targeting that id in production

Specified by:

retrieveSandboxItemsForEntityId in interface WorkflowSandBoxItemDao

siteId - @return

retrieveAllNonContainerSandboxItemsForEntityId

public List<WorkflowSandBoxItem> retrieveAllNonContainerSandboxItemsForEntityId(Long entityId,
                                                                                String className,
                                                                                Boolean includeArchived,
                                                                                Long siteId)

Description copied from interface: WorkflowSandBoxItemDao

Retrieves all WorkflowSandBoxItem associated with container instances targeting that id in production

Specified by:

retrieveAllNonContainerSandboxItemsForEntityId in interface WorkflowSandBoxItemDao

siteId - @return

retrieveAuthorNamesForWorkflowItems

public Map<Long,String> retrieveAuthorNamesForWorkflowItems(Set<Long> workflowItemIds)

Specified by:

retrieveAuthorNamesForWorkflowItems in interface WorkflowSandBoxItemDao

retrieveWorkflowItemByIds

public List<WorkflowSandBoxItem> retrieveWorkflowItemByIds(List<Long> ids,
                                                           boolean ascending)

Specified by:

retrieveWorkflowItemByIds in interface WorkflowSandBoxItemDao

retrieveWorkflowItemByOriginalItemIds

public List<WorkflowSandBoxItem> retrieveWorkflowItemByOriginalItemIds(List<Long> ids)

Specified by:

retrieveWorkflowItemByOriginalItemIds in interface WorkflowSandBoxItemDao

retrieveWorkflowItemByOriginalEntityId

public List<WorkflowSandBoxItem> retrieveWorkflowItemByOriginalEntityId(Long id)

Specified by:

retrieveWorkflowItemByOriginalEntityId in interface WorkflowSandBoxItemDao

retrieveMostRecentItemBasedOnOriginal

public WorkflowSandBoxItem retrieveMostRecentItemBasedOnOriginal(List<Long> ids)

Specified by:

retrieveMostRecentItemBasedOnOriginal in interface WorkflowSandBoxItemDao

retrieveSandBoxItemIdsForSandbox

public List<Long> retrieveSandBoxItemIdsForSandbox(Long sandBox,
                                                   boolean containerOnly)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve WorkflowSandBoxItem ids in the sandbox

Specified by:

retrieveSandBoxItemIdsForSandbox in interface WorkflowSandBoxItemDao

Parameters:

sandBox - the sandbox to search in

containerOnly - whether or not to only include container items WorkflowSandBoxItem.getContainer()

Returns:

the list of item ids

retrieveSandBoxItemIdsWithEventsForSandbox

public List<Long> retrieveSandBoxItemIdsWithEventsForSandbox(Long sandBox)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve WorkflowSandBoxItem ids in the sandbox that have a non-archived WorkflowEvent

Specified by:

retrieveSandBoxItemIdsWithEventsForSandbox in interface WorkflowSandBoxItemDao

Parameters:

sandBox - the sandbox to search in

Returns:

the list of item ids

retrieveGroupNames

public List<String> retrieveGroupNames(Long sandBox)

Description copied from interface: WorkflowSandBoxItemDao

Find all the unique change group names that currently exist in the sandbox

Specified by:

retrieveGroupNames in interface WorkflowSandBoxItemDao

Parameters:

sandBox - the sandbox to search in

Returns:

the list of unique change group names

retrieveWorkflowItemsByGroupName

public List<WorkflowSandBoxItem> retrieveWorkflowItemsByGroupName(Long sandBoxId,
                                                                  String groupName)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve by sandbox and change group name

Specified by:

retrieveWorkflowItemsByGroupName in interface WorkflowSandBoxItemDao

Parameters:

sandBoxId - the sandbox to search in

groupName - the change group name

Returns:

the list of items

retrieveWorkflowItemsByGroupName

public List<WorkflowSandBoxItem> retrieveWorkflowItemsByGroupName(Long sandBoxId,
                                                                  Long originalSandBoxId,
                                                                  String groupName,
                                                                  boolean isContainer)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve by sandbox and change group name

Specified by:

retrieveWorkflowItemsByGroupName in interface WorkflowSandBoxItemDao

Parameters:

sandBoxId - the sandbox to search in

originalSandBoxId - the original sandbox from which this item was promoted (null for user sandbox items)

groupName - the change group name

isContainer - whether or not to search for items that are containers WorkflowSandBoxItem.getContainer()

Returns:

the list of items

retrieveWorkflowItemsByGroupName

public List<WorkflowSandBoxItem> retrieveWorkflowItemsByGroupName(Long sandBoxId,
                                                                  String groupName,
                                                                  boolean isContainer)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve by sandbox and change group name

Specified by:

retrieveWorkflowItemsByGroupName in interface WorkflowSandBoxItemDao

Parameters:

sandBoxId - the sandbox to search in

groupName - the change group name

isContainer - whether or not to search for items that are containers WorkflowSandBoxItem.getContainer()

Returns:

the list of items

retrieveWorkflowItemsCountByGroupNameAndType

public Long retrieveWorkflowItemsCountByGroupNameAndType(Long sandBoxId,
                                                         String groupName,
                                                         SandBoxOperationType type,
                                                         Long causedBy)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve the items by sandbox and change group name

Specified by:

retrieveWorkflowItemsCountByGroupNameAndType in interface WorkflowSandBoxItemDao

Parameters:

sandBoxId - the sandbox to search in

groupName - the change group name

type - the operation performed (i.e. add, update, etc...)

causedBy - filter out results that were generated as a result of this WorkflowSandboxItem (optional, can be null)

Returns:

the matching WorkflowSandBoxItem instances

retrieveWorkflowItemsCountByGroupName

public Long retrieveWorkflowItemsCountByGroupName(Long sandBoxId,
                                                  String groupName,
                                                  Long causedBy)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve the count by sandbox and change group name

Specified by:

retrieveWorkflowItemsCountByGroupName in interface WorkflowSandBoxItemDao

Parameters:

sandBoxId - the sandbox to search in

groupName - the change group name

causedBy - filter out results that were generated as a result of this WorkflowSandboxItem (optional, can be null)

Returns:

the count of matching WorkflowSandBoxItem instances

retrieveWorkflowItemsForSync

public List<WorkflowSandBoxItem> retrieveWorkflowItemsForSync(Long sandBoxId,
                                                              String groupName,
                                                              Long inheritedVersion)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve items that need to be synced

Specified by:

retrieveWorkflowItemsForSync in interface WorkflowSandBoxItemDao

Parameters:

sandBoxId - the sandbox to search in

groupName - the change group name

inheritedVersion - any items whose version is greater than this are candidates

Returns:

the list of items needing to be synced

archiveEmptyEventIfNecessary

public int archiveEmptyEventIfNecessary(Long eventId)

Description copied from interface: WorkflowSandBoxItemDao

Archive any events that have no associated WorkflowSandBoxItem instances

Specified by:

archiveEmptyEventIfNecessary in interface WorkflowSandBoxItemDao

Parameters:

eventId - the event to check

archiveEmptyEventWithStatus

public int archiveEmptyEventWithStatus(Long eventId)

Specified by:

archiveEmptyEventWithStatus in interface WorkflowSandBoxItemDao

archiveAllEmptyEvents

public int archiveAllEmptyEvents()

Specified by:

archiveAllEmptyEvents in interface WorkflowSandBoxItemDao

archiveEvents

public int archiveEvents(List<Long> eventIds)

Description copied from interface: WorkflowSandBoxItemDao

Updates the archived flag for the given WorkflowEvents to be Y.

Specified by:

archiveEvents in interface WorkflowSandBoxItemDao

Parameters:

eventIds - the WorkflowEvents to update

Returns:

the total number of records updated

archiveAllEmptyProgressEventsByPromotionMarker

public int archiveAllEmptyProgressEventsByPromotionMarker()

Description copied from interface: WorkflowSandBoxItemDao

Archive any inprogress WorkflowEvents whose promotionMarker related WorkflowSandBoxItems are all archived and who does not have any completed promotion WorkflowSandBoxItem associated. This is an empty inprogress promotion event that never successfully completed a promotion on one of its associated items, but all those associated items have been otherwise archived. This is a useless inprogress promotion and probably represents the results of a failed promotion that was handled by other means.

Specified by:

archiveAllEmptyProgressEventsByPromotionMarker in interface WorkflowSandBoxItemDao

Returns:

archiveStaleEventsIfNecessary

public int archiveStaleEventsIfNecessary(Long eventId,
                                         Long itemId)

Specified by:

archiveStaleEventsIfNecessary in interface WorkflowSandBoxItemDao

retrieveItemIdsForEvent

public List<Long> retrieveItemIdsForEvent(Long eventId)

Specified by:

retrieveItemIdsForEvent in interface WorkflowSandBoxItemDao

retrieveItemIdsForEventIncludingArchived

public List<Long> retrieveItemIdsForEventIncludingArchived(Long eventId)

Specified by:

retrieveItemIdsForEventIncludingArchived in interface WorkflowSandBoxItemDao

retrieveItemIdsForEventIncludingArchivedByPromotionMarker

public List<Long> retrieveItemIdsForEventIncludingArchivedByPromotionMarker(Long eventId)

Specified by:

retrieveItemIdsForEventIncludingArchivedByPromotionMarker in interface WorkflowSandBoxItemDao

retrieveItemIdsForEvents

public List<Long> retrieveItemIdsForEvents(Long[] eventIds)

Specified by:

retrieveItemIdsForEvents in interface WorkflowSandBoxItemDao

addWorkflowSandBoxItem

public WorkflowSandBoxItem addWorkflowSandBoxItem(Long sandBox,
                                                  Long originalSandBox,
                                                  Long creationSandBox,
                                                  Long parentSandBox,
                                                  SandBoxOperationType operationType,
                                                  String description,
                                                  String groupDescription,
                                                  Long temporaryId,
                                                  Long originalId,
                                                  String itemName,
                                                  SandBoxOperationOrigin operationOrigin,
                                                  String msg,
                                                  Long originalWorkflowItemId)

Specified by:

addWorkflowSandBoxItem in interface WorkflowSandBoxItemDao

retrieveWorkflowSandBoxItemBySandboxAndItemId

public WorkflowSandBoxItem retrieveWorkflowSandBoxItemBySandboxAndItemId(Long currentSandBoxId,
                                                                         Long itemId)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve instances based on sandbox and entity item id

Specified by:

retrieveWorkflowSandBoxItemBySandboxAndItemId in interface WorkflowSandBoxItemDao

Parameters:

currentSandBoxId - the current sandbox

itemId - the entity item id EntityItem.getId()

Returns:

the matching WorkflowSandBoxItem instance

retrieveWorkflowSandBoxItemByCeilingTypeAndItemId

public WorkflowSandBoxItem retrieveWorkflowSandBoxItemByCeilingTypeAndItemId(Long currentSandBoxId,
                                                                             String ceil,
                                                                             Long itemId)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve instances based on sandbox, ceiling entity, and entity id

Specified by:

retrieveWorkflowSandBoxItemByCeilingTypeAndItemId in interface WorkflowSandBoxItemDao

Returns:

the matching WorkflowSandBoxItem instance

retrieveWorkflowSandBoxItemBySandboxAndItemId

public WorkflowSandBoxItem retrieveWorkflowSandBoxItemBySandboxAndItemId(List<Long> sandBoxIds,
                                                                         Long currentSandBoxId,
                                                                         Long itemId,
                                                                         boolean includeArchived)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve instances based on sandbox and entity item id

Specified by:

retrieveWorkflowSandBoxItemBySandboxAndItemId in interface WorkflowSandBoxItemDao

Parameters:

sandBoxIds - the sandboxes to search in

currentSandBoxId - the current sandbox

itemId - the entity item id EntityItem.getId()

includeArchived - whether or not to include archived WorkflowSandBoxItem instances

Returns:

the matching WorkflowSandBoxItem instance

retrieveAllContainersByCeilingTypeAndId

public List<Long> retrieveAllContainersByCeilingTypeAndId(String ceiling,
                                                          Long id)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve all container item ids for a given ceiling entity and original id

Specified by:

retrieveAllContainersByCeilingTypeAndId in interface WorkflowSandBoxItemDao

Returns:

retrieveAllContainersByCeilingTypeAndId

public List<Long> retrieveAllContainersByCeilingTypeAndId(String ceiling,
                                                          String itemId)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve all container item ids for a given ceiling entity and original id

Specified by:

retrieveAllContainersByCeilingTypeAndId in interface WorkflowSandBoxItemDao

Returns:

retrieveAllContainersByCeilingTypeAndId

public List<Long> retrieveAllContainersByCeilingTypeAndId(String ceiling,
                                                          String itemId,
                                                          boolean includeArchived)

Specified by:

retrieveAllContainersByCeilingTypeAndId in interface WorkflowSandBoxItemDao

retrieveWorkflowSandBoxItemByEntityItemId

public WorkflowSandBoxItem retrieveWorkflowSandBoxItemByEntityItemId(Long entityItemId)

Description copied from interface: WorkflowSandBoxItemDao

Find by the associated EntityItem

Specified by:

retrieveWorkflowSandBoxItemByEntityItemId in interface WorkflowSandBoxItemDao

Parameters:

entityItemId - the associated entity item id to search by

Returns:

the search result

retrieveChildItemsForContainerItems

public List<WorkflowSandBoxItem> retrieveChildItemsForContainerItems(List<Long> containerIds,
                                                                     Long sandBoxId)

Description copied from interface: WorkflowSandBoxItemDao

Based on a list of WorkflowSandBoxItem ids that are containers (containers are WorkflowSandBoxItem instances that have child items), retrieve all the associated child items.

Specified by:

retrieveChildItemsForContainerItems in interface WorkflowSandBoxItemDao

Parameters:

containerIds - the ids for WorkflowSandBoxItem instances that are containers

sandBoxId - the sandbox to search in

Returns:

the list of WorkflowSandBoxItem instances that are children

retrieveForwardDependentItems

public List<ChildItem> retrieveForwardDependentItems(List<Long> sandBoxItemids,
                                                     Long sandBoxId)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve dependent items

Specified by:

retrieveForwardDependentItems in interface WorkflowSandBoxItemDao

Returns:

the list of items

See Also:

com.broadleafcommerce.enterprise.workflow.admin.service.behavior.DependencyWorkflowManager#getForwardDependentItems(Long[])

retrieveReverseDependentItems

public List<ChildItem> retrieveReverseDependentItems(List<Long> sandBoxItemids,
                                                     Long sandBoxId)

Description copied from interface: WorkflowSandBoxItemDao

Retrieve dependent items

Specified by:

retrieveReverseDependentItems in interface WorkflowSandBoxItemDao

Returns:

the list of items

See Also:

com.broadleafcommerce.enterprise.workflow.admin.service.behavior.DependencyWorkflowManager#getReverseDependentItems(Long[])

delete

public void delete(WorkflowSandBoxItem item)

Specified by:

delete in interface WorkflowSandBoxItemDao

save

public WorkflowSandBoxItem save(WorkflowSandBoxItem item)

Specified by:

save in interface WorkflowSandBoxItemDao

updateItemVersionAndInheritedVersionByGroup

public void updateItemVersionAndInheritedVersionByGroup(Long sandBoxId,
                                                        String groupName,
                                                        Long version,
                                                        Long inheritedVersion)

Specified by:

updateItemVersionAndInheritedVersionByGroup in interface WorkflowSandBoxItemDao

setScheduledItems

public int setScheduledItems(List<Long> itemIds,
                             Date scheduledDate)

Description copied from interface: WorkflowSandBoxItemDao

Set the deployment date for one or more items

Specified by:

setScheduledItems in interface WorkflowSandBoxItemDao

Parameters:

itemIds - the WorkflowSandBoxItem records to update

scheduledDate - the deployment date

Returns:

the number or database records effected

setPromotionMarker

public int setPromotionMarker(List<Long> itemIds,
                              Long eventId)

Specified by:

setPromotionMarker in interface WorkflowSandBoxItemDao

getIdsByPromotionMarker

public List<Long> getIdsByPromotionMarker(Long promotionMarker)

Specified by:

getIdsByPromotionMarker in interface WorkflowSandBoxItemDao

unSetScheduledItems

public void unSetScheduledItems(List<Long> itemIds)

Specified by:

unSetScheduledItems in interface WorkflowSandBoxItemDao

setScheduledEvents

public int setScheduledEvents(Long eventId,
                              Date scheduledDate)

Specified by:

setScheduledEvents in interface WorkflowSandBoxItemDao

isEventInProgress

public boolean isEventInProgress(List<Long> eventId)

Specified by:

isEventInProgress in interface WorkflowSandBoxItemDao

unSetScheduledEvents

public void unSetScheduledEvents(Long eventId)

Specified by:

unSetScheduledEvents in interface WorkflowSandBoxItemDao

updateItemVersionByGroup

public void updateItemVersionByGroup(Long sandBoxId,
                                     String groupName,
                                     Long version)

Specified by:

updateItemVersionByGroup in interface WorkflowSandBoxItemDao

retrieveEarlyAbortedInProgressPromotions

public List<EarlyAbortedPromotionCandidate> retrieveEarlyAbortedInProgressPromotions()

Description copied from interface: WorkflowSandBoxItemDao

Retrieve in progress promotions that appear to have failed before being completely setup. This is basically an in progress promotion that has not started async processing.

Specified by:

retrieveEarlyAbortedInProgressPromotions in interface WorkflowSandBoxItemDao

Returns:

retrieveEarlyAbortedInProgressApprovals

public List<EarlyAbortedPromotionCandidate> retrieveEarlyAbortedInProgressApprovals()

Description copied from interface: WorkflowSandBoxItemDao

Retrieve in progress approvals that appear to have failed before being completely setup. This is basically an in progress approval that has not been setup as a scheduled job.

Specified by:

retrieveEarlyAbortedInProgressApprovals in interface WorkflowSandBoxItemDao

Returns:

retrieveItemsByEntityItemAndChangeType

public List<WorkflowSandBoxItem> retrieveItemsByEntityItemAndChangeType(Long entityItemId,
                                                                        org.broadleafcommerce.openadmin.server.service.type.ChangeType changeType)

Description copied from interface: WorkflowSandBoxItemDao

Look for items for a specific change and change type

Specified by:

retrieveItemsByEntityItemAndChangeType in interface WorkflowSandBoxItemDao

Parameters:

entityItemId - the change record (WorkflowSandBoxItem.getEntityItemId()

changeType - add, update, delete

Returns:

the list of items

retrieveSandboxItemsBySandboxOrigin

public List<Long> retrieveSandboxItemsBySandboxOrigin(Long sandboxId,
                                                      String origin)

Description copied from interface: WorkflowSandBoxItemDao

Returns a list of Ids of workflowSandBoxItems that are associated to the given SandBox and SandBox origin

Specified by:

retrieveSandboxItemsBySandboxOrigin in interface WorkflowSandBoxItemDao

Returns:

retrieveContainerSandboxItemsForPromotion

public List<Long> retrieveContainerSandboxItemsForPromotion(Long sandboxId,
                                                            String origin)

Description copied from interface: WorkflowSandBoxItemDao

Returns a list of Ids of workflowSandBoxItems that are associated to the given SandBox and SandBox origin that do not have an associated WorkflowSandBoxItem.getPromotionMarker() which would signify that it has been promoted or has an associated failed promotion.

Specified by:

retrieveContainerSandboxItemsForPromotion in interface WorkflowSandBoxItemDao

Returns:

isDeploymentRetryable

public boolean isDeploymentRetryable(long deploymentId)

Description copied from interface: WorkflowSandBoxItemDao

Detect whether or not a deployment can be retried via the admin UI. Retryable deployments are stuck deployments that are not actively being worked on by the system. For a deployment to allow retry, it must utilize the new WorkflowEventSetupStatus.PROMOTION_PROCESSING_RETRY_CAPABLE for one or more of the associated WorkflowEvent instances. See WorkflowEvent.getSetupStatus().

Specified by:

isDeploymentRetryable in interface WorkflowSandBoxItemDao

Returns:

lockExecution

public boolean lockExecution(String key)

Description copied from interface: WorkflowSandBoxItemDao

Attempt to perform an optimistic lock on the key. Used in conjunction with ExecutionLockUtil

Specified by:

lockExecution in interface WorkflowSandBoxItemDao

Parameters:

key - the key to lock on

unlockExecution

public void unlockExecution(String key)

Description copied from interface: WorkflowSandBoxItemDao

Attempt to perform an optimistic unlock on the key. Used in conjunction with ExecutionLockUtil

Specified by:

unlockExecution in interface WorkflowSandBoxItemDao

Parameters:

key - the key to unlock

resetItemsForPromotion

public int resetItemsForPromotion(List<Long> sandBoxItemIds,
                                  Long eventId)

Description copied from interface: WorkflowSandBoxItemDao

Update the WorkflowSandBoxItem.getPromotionMarker() value with the eventId for the list of sandBoxItemIds.

Specified by:

resetItemsForPromotion in interface WorkflowSandBoxItemDao

Returns:

clearItems

public int clearItems(List<Long> sandBoxItemIds)

Description copied from interface: WorkflowSandBoxItemDao

Remove the WorkflowSandBoxItem.getPromotionMarker() value for the list of sandBoxItemIds.

Specified by:

clearItems in interface WorkflowSandBoxItemDao

Returns: