com.broadleafcommerce.enterprise.workflow.service

Class WorkflowSandBoxItemServiceImpl

java.lang.Object

com.broadleafcommerce.enterprise.workflow.admin.service.AbstractWorkflowSupport

com.broadleafcommerce.enterprise.workflow.service.WorkflowSandBoxItemServiceImpl

All Implemented Interfaces:

WorkflowSupport, WorkflowSandBoxItemService

@Service(value="blWorkflowSandBoxItemService")
public class WorkflowSandBoxItemServiceImpl
extends AbstractWorkflowSupport
implements WorkflowSandBoxItemService

Field Summary

Fields

Modifier and Type	Field and Description
protected WorkflowSandBoxItemDao	dao
protected EntityItemDao	entityItemDao
protected com.broadleafcommerce.enterprise.common.extension.enterprise.WorkflowSandBoxItemServiceExtensionManager	extensionManager
protected PropertyDao	propertyDao
protected org.broadleafcommerce.common.sandbox.service.SandBoxService	sandBoxService
protected EnterpriseWorkflowLogger	workflowLogger
protected WorkflowSandBoxItemErrorMessageFactory	workflowSandboxItemErrorMessageFactory
protected WorkflowStateManager	workflowStateManager

Constructor Summary

Constructors

Constructor and Description
WorkflowSandBoxItemServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected void	addSubItemProperties(EntityItem item, List<Property> list)
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, String sectionCrumbDescription, String sectionCrumbGroupDescription)
void	archiveEmptyEventIfNecessary(Long eventId, boolean testOtherEventsAsWell) Archive any events that have no associated WorkflowSandBoxItem instances
int	archiveEmptyEventIfNecessaryWithStatus(Long eventId, boolean testOtherEventsAsWell)
WorkflowSandBoxItem	archiveWorkflowItemAndChildren(Long itemId) Explicitly archive a WorkflowSandBoxItem and all its children (if applicable)
void	archiveWorkflowItemsBySandBoxId(Long sandBoxId) Archive all WorkflowSandBoxItems associated to the given SandBox
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
Map<Long,String>	findAuthorNamesForWorkflowItems(Set<Long> workflowItemIds)
List<Property>	findPropertiesForItem(Long workflowSandBoxItemId) Retrieve all the persisted Property values for a change.
List<Property>	findShallowPropertiesForItem(Long workflowSandBoxItemId)
Class<?>	getEntityClass(WorkflowSandBoxItem item) Get the class for the top-level entity involved in this change.
protected List<WorkflowSandBoxItem>	getExistingContainers(Long sandBox, Long originalSandBox, String generalGroup)
List<Long>	getIdsByPromotionMarker(Long promotionMarker)
boolean	isEventInProgress(List<Long> eventId)
Boolean	itemHasDeepChanges(Long workflowSandBoxItemId)
boolean	lockExecution(String key) Attempt to perform an optimistic lock on the key.
int	resetItemsForPromotion(List<Long> sandBoxItemIds, Long eventId) Update the WorkflowSandBoxItem.getPromotionMarker() value with the eventId for the list of sandBoxItemIds.
List<Long>	retrieveAllContainersByCeilingTypeAndId(String ceil, Long id) Retrieve all container item ids for a given ceiling entity and original id
List<Long>	retrieveAllContainersByCeilingTypeAndId(String ceil, String itemId) Retrieve all container item ids for a given ceiling entity and original id
List<Long>	retrieveAllContainersByCeilingTypeAndId(String ceil, String itemId, boolean includeArchived)
List<WorkflowSandBoxItem>	retrieveAllRelatedSandboxItemsForEntityIdIncludingArchived(Long entityId, String className, Long siteId) Retrieves all WorkflowSandBoxItem's related to the passed in ID including archived records for the site.
EntityItem	retrieveAssociatedEntityItem(Long workflowSandBoxItemId) Retrieve the persisted representation of the PersistencePackage for this change.
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.
String	retrieveErrorMessage(Long sandboxItemId) Retrieves the latest error message for a given WorkflowSandBoxItem.
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<WorkflowSandBoxItem>	retrieveItemContainerLineage(Long sandBoxItemId) Retrieves the lineage of container items for a given WorkflowSandBoxItem's id
List<WorkflowSandBoxItem>	retrieveItemContainerLineage(WorkflowSandBoxItem sandBoxItem) Retrieves the lineage of container items for a given WorkflowSandBoxItem
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, Long siteId) Retrieves the workflowSanboxItems targeting the passed in ID for the site
List<WorkflowSandBoxItem>	retrieveSandboxItemsForEntityIdIncludingArchived(Long entityId, String className, Long siteId) Retrieves the workflowSanboxItems targeting the passed in ID including archived records for the site
WorkflowSandBoxItem	retrieveWorkflowItemById(Long id)
WorkflowSandBoxItem	retrieveWorkflowItemById(Long id, boolean useCache)
List<WorkflowSandBoxItem>	retrieveWorkflowItemByIds(List<Long> ids)
List<WorkflowSandBoxItem>	retrieveWorkflowItemByOriginalEntityId(Long id)
WorkflowSandBoxItem	retrieveWorkflowItemByOriginalItemId(Long originalItemId)
List<WorkflowSandBoxItem>	retrieveWorkflowItemsByGroupName(Long sandBoxId, String groupName) 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 item 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 sourceSandBoxId, 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 com.broadleafcommerce.enterprise.workflow.admin.service.AbstractWorkflowSupport

getGroupNameGeneralization

Methods inherited from class java.lang.Object

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

Field Detail

dao

protected WorkflowSandBoxItemDao dao

propertyDao

protected PropertyDao propertyDao

entityItemDao

protected EntityItemDao entityItemDao

sandBoxService

protected org.broadleafcommerce.common.sandbox.service.SandBoxService sandBoxService

workflowStateManager

protected WorkflowStateManager workflowStateManager

workflowSandboxItemErrorMessageFactory

protected WorkflowSandBoxItemErrorMessageFactory workflowSandboxItemErrorMessageFactory

extensionManager

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

workflowLogger

@Autowired(required=false)
protected EnterpriseWorkflowLogger workflowLogger

Constructor Detail

WorkflowSandBoxItemServiceImpl

public WorkflowSandBoxItemServiceImpl()

Method Detail

findPropertiesForItem

public List<Property> findPropertiesForItem(Long workflowSandBoxItemId)

Description copied from interface: WorkflowSandBoxItemService

Retrieve all the persisted Property values for a change.

Specified by:

findPropertiesForItem in interface WorkflowSandBoxItemService

Parameters:

workflowSandBoxItemId - the change id

Returns:

the properties

addSubItemProperties

protected void addSubItemProperties(EntityItem item,
                                    List<Property> list)

findShallowPropertiesForItem

public List<Property> findShallowPropertiesForItem(Long workflowSandBoxItemId)

Specified by:

findShallowPropertiesForItem in interface WorkflowSandBoxItemService

itemHasDeepChanges

public Boolean itemHasDeepChanges(Long workflowSandBoxItemId)

Specified by:

itemHasDeepChanges in interface WorkflowSandBoxItemService

retrieveWorkflowItemById

public WorkflowSandBoxItem retrieveWorkflowItemById(Long id)

Specified by:

retrieveWorkflowItemById in interface WorkflowSandBoxItemService

retrieveWorkflowItemById

public WorkflowSandBoxItem retrieveWorkflowItemById(Long id,
                                                    boolean useCache)

Specified by:

retrieveWorkflowItemById in interface WorkflowSandBoxItemService

retrieveWorkflowItemByOriginalEntityId

public List<WorkflowSandBoxItem> retrieveWorkflowItemByOriginalEntityId(Long id)

Specified by:

retrieveWorkflowItemByOriginalEntityId in interface WorkflowSandBoxItemService

findAuthorNamesForWorkflowItems

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

Specified by:

findAuthorNamesForWorkflowItems in interface WorkflowSandBoxItemService

retrieveWorkflowItemByIds

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

Specified by:

retrieveWorkflowItemByIds in interface WorkflowSandBoxItemService

retrieveAssociatedEntityItem

public EntityItem retrieveAssociatedEntityItem(Long workflowSandBoxItemId)

Description copied from interface: WorkflowSandBoxItemService

Retrieve the persisted representation of the PersistencePackage for this change. This is the specifics of the change.

Specified by:

retrieveAssociatedEntityItem in interface WorkflowSandBoxItemService

Parameters:

workflowSandBoxItemId - the change id

Returns:

the specifics of the change.

See Also:

WorkflowSandBoxItem.getEntityItemId()

retrieveItemIdsForEvent

public List<Long> retrieveItemIdsForEvent(Long eventId)

Specified by:

retrieveItemIdsForEvent in interface WorkflowSandBoxItemService

retrieveItemIdsForEventIncludingArchived

public List<Long> retrieveItemIdsForEventIncludingArchived(Long eventId)

Specified by:

retrieveItemIdsForEventIncludingArchived in interface WorkflowSandBoxItemService

retrieveItemIdsForEventIncludingArchivedByPromotionMarker

public List<Long> retrieveItemIdsForEventIncludingArchivedByPromotionMarker(Long eventId)

Specified by:

retrieveItemIdsForEventIncludingArchivedByPromotionMarker in interface WorkflowSandBoxItemService

retrieveItemIdsForEvents

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

Specified by:

retrieveItemIdsForEvents in interface WorkflowSandBoxItemService

archiveEmptyEventIfNecessary

public void archiveEmptyEventIfNecessary(Long eventId,
                                         boolean testOtherEventsAsWell)

Description copied from interface: WorkflowSandBoxItemService

Archive any events that have no associated WorkflowSandBoxItem instances

Specified by:

archiveEmptyEventIfNecessary in interface WorkflowSandBoxItemService

Parameters:

eventId - the event to check

archiveEmptyEventIfNecessaryWithStatus

public int archiveEmptyEventIfNecessaryWithStatus(Long eventId,
                                                  boolean testOtherEventsAsWell)

Specified by:

archiveEmptyEventIfNecessaryWithStatus in interface WorkflowSandBoxItemService

getEntityClass

public Class<?> getEntityClass(WorkflowSandBoxItem item)

Description copied from interface: WorkflowSandBoxItemService

Get the class for the top-level entity involved in this change.

Specified by:

getEntityClass in interface WorkflowSandBoxItemService

Parameters:

item - the change

Returns:

the top-level entity class

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,
                                                  String sectionCrumbDescription,
                                                  String sectionCrumbGroupDescription)

Specified by:

addWorkflowSandBoxItem in interface WorkflowSandBoxItemService

getExistingContainers

protected List<WorkflowSandBoxItem> getExistingContainers(Long sandBox,
                                                          Long originalSandBox,
                                                          String generalGroup)

retrieveWorkflowSandBoxItemBySandboxAndItemId

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

Description copied from interface: WorkflowSandBoxItemService

Retrieve instances based on sandbox and entity item id

Specified by:

retrieveWorkflowSandBoxItemBySandboxAndItemId in interface WorkflowSandBoxItemService

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

retrieveWorkflowSandBoxItemByEntityItemId

public WorkflowSandBoxItem retrieveWorkflowSandBoxItemByEntityItemId(Long entityItemId)

Description copied from interface: WorkflowSandBoxItemService

Find by the associated EntityItem

Specified by:

retrieveWorkflowSandBoxItemByEntityItemId in interface WorkflowSandBoxItemService

Parameters:

entityItemId - the associated entity item id to search by

Returns:

the search result

updateItemVersionAndInheritedVersionByGroup

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

Specified by:

updateItemVersionAndInheritedVersionByGroup in interface WorkflowSandBoxItemService

retrieveWorkflowItemsForSync

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

Description copied from interface: WorkflowSandBoxItemService

Retrieve items that need to be synced

Specified by:

retrieveWorkflowItemsForSync in interface WorkflowSandBoxItemService

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

setScheduledEvents

public int setScheduledEvents(Long eventId,
                              Date scheduledDate)

Specified by:

setScheduledEvents in interface WorkflowSandBoxItemService

isEventInProgress

public boolean isEventInProgress(List<Long> eventId)

Specified by:

isEventInProgress in interface WorkflowSandBoxItemService

retrieveEarlyAbortedInProgressPromotions

public List<EarlyAbortedPromotionCandidate> retrieveEarlyAbortedInProgressPromotions()

Description copied from interface: WorkflowSandBoxItemService

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 WorkflowSandBoxItemService

Returns:

retrieveEarlyAbortedInProgressApprovals

public List<EarlyAbortedPromotionCandidate> retrieveEarlyAbortedInProgressApprovals()

Description copied from interface: WorkflowSandBoxItemService

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 WorkflowSandBoxItemService

Returns:

unSetScheduledItems

public void unSetScheduledItems(List<Long> itemIds)

Specified by:

unSetScheduledItems in interface WorkflowSandBoxItemService

delete

public void delete(WorkflowSandBoxItem item)

Specified by:

delete in interface WorkflowSandBoxItemService

retrieveForwardDependentItems

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

Description copied from interface: WorkflowSandBoxItemService

Retrieve dependent items

Specified by:

retrieveForwardDependentItems in interface WorkflowSandBoxItemService

Returns:

the list of items

See Also:

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

updateItemVersionByGroup

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

Specified by:

updateItemVersionByGroup in interface WorkflowSandBoxItemService

retrieveGroupNames

public List<String> retrieveGroupNames(Long sandBox)

Description copied from interface: WorkflowSandBoxItemService

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

Specified by:

retrieveGroupNames in interface WorkflowSandBoxItemService

Parameters:

sandBox - the sandbox to search in

Returns:

the list of unique change group names

unSetScheduledEvents

public void unSetScheduledEvents(Long eventId)

Specified by:

unSetScheduledEvents in interface WorkflowSandBoxItemService

save

public WorkflowSandBoxItem save(WorkflowSandBoxItem item)

Specified by:

save in interface WorkflowSandBoxItemService

setScheduledItems

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

Description copied from interface: WorkflowSandBoxItemService

Set the deployment date for one or more items

Specified by:

setScheduledItems in interface WorkflowSandBoxItemService

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 WorkflowSandBoxItemService

getIdsByPromotionMarker

public List<Long> getIdsByPromotionMarker(Long promotionMarker)

Specified by:

getIdsByPromotionMarker in interface WorkflowSandBoxItemService

retrieveReverseDependentItems

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

Description copied from interface: WorkflowSandBoxItemService

Retrieve dependent items

Specified by:

retrieveReverseDependentItems in interface WorkflowSandBoxItemService

Returns:

the list of items

See Also:

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

retrieveChildItemsForContainerItems

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

Description copied from interface: WorkflowSandBoxItemService

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 WorkflowSandBoxItemService

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

retrieveWorkflowItemsByGroupName

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

Description copied from interface: WorkflowSandBoxItemService

Retrieve by sandbox and change group name

Specified by:

retrieveWorkflowItemsByGroupName in interface WorkflowSandBoxItemService

Parameters:

sandBoxId - the sandbox to search in

groupName - the change group name

Returns:

the list of items

retrieveWorkflowSandBoxItemBySandboxAndItemId

public WorkflowSandBoxItem retrieveWorkflowSandBoxItemBySandboxAndItemId(Long currentSandBoxId,
                                                                         Long itemId)

Description copied from interface: WorkflowSandBoxItemService

Retrieve instances based on sandbox and entity item id

Specified by:

retrieveWorkflowSandBoxItemBySandboxAndItemId in interface WorkflowSandBoxItemService

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: WorkflowSandBoxItemService

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

Specified by:

retrieveWorkflowSandBoxItemByCeilingTypeAndItemId in interface WorkflowSandBoxItemService

Returns:

the matching WorkflowSandBoxItem instance

retrieveAllContainersByCeilingTypeAndId

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

Description copied from interface: WorkflowSandBoxItemService

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

Specified by:

retrieveAllContainersByCeilingTypeAndId in interface WorkflowSandBoxItemService

Returns:

retrieveAllContainersByCeilingTypeAndId

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

Description copied from interface: WorkflowSandBoxItemService

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

Specified by:

retrieveAllContainersByCeilingTypeAndId in interface WorkflowSandBoxItemService

Returns:

retrieveAllContainersByCeilingTypeAndId

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

Specified by:

retrieveAllContainersByCeilingTypeAndId in interface WorkflowSandBoxItemService

lockExecution

public boolean lockExecution(String key)

Description copied from interface: WorkflowSandBoxItemService

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

Specified by:

lockExecution in interface WorkflowSandBoxItemService

Parameters:

key - the key to lock on

retrieveItemsByEntityItemAndChangeType

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

Description copied from interface: WorkflowSandBoxItemService

Look for items for a specific change and change type

Specified by:

retrieveItemsByEntityItemAndChangeType in interface WorkflowSandBoxItemService

Parameters:

entityItemId - the change record (WorkflowSandBoxItem.getEntityItemId()

changeType - add, update, delete

Returns:

the list of items

unlockExecution

public void unlockExecution(String key)

Description copied from interface: WorkflowSandBoxItemService

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

Specified by:

unlockExecution in interface WorkflowSandBoxItemService

Parameters:

key - the key to unlock

retrieveWorkflowItemsCountByGroupName

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

Description copied from interface: WorkflowSandBoxItemService

Retrieve the count by sandbox and change group name

Specified by:

retrieveWorkflowItemsCountByGroupName in interface WorkflowSandBoxItemService

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

retrieveWorkflowItemsCountByGroupNameAndType

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

Description copied from interface: WorkflowSandBoxItemService

Retrieve the items by sandbox and change group name

Specified by:

retrieveWorkflowItemsCountByGroupNameAndType in interface WorkflowSandBoxItemService

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

retrieveSandBoxItemIdsForSandbox

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

Description copied from interface: WorkflowSandBoxItemService

Retrieve WorkflowSandBoxItem ids in the sandbox

Specified by:

retrieveSandBoxItemIdsForSandbox in interface WorkflowSandBoxItemService

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: WorkflowSandBoxItemService

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

Specified by:

retrieveSandBoxItemIdsWithEventsForSandbox in interface WorkflowSandBoxItemService

Parameters:

sandBox - the sandbox to search in

Returns:

the list of item ids

filterWorkflowItemsByClass

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

Description copied from interface: WorkflowSandBoxItemService

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 WorkflowSandBoxItemService

Returns:

the filtered IDs

retrieveMostRecentItemBasedOnOriginal

public WorkflowSandBoxItem retrieveMostRecentItemBasedOnOriginal(List<Long> ids)

Specified by:

retrieveMostRecentItemBasedOnOriginal in interface WorkflowSandBoxItemService

retrieveWorkflowItemByOriginalItemId

public WorkflowSandBoxItem retrieveWorkflowItemByOriginalItemId(Long originalItemId)

Specified by:

retrieveWorkflowItemByOriginalItemId in interface WorkflowSandBoxItemService

archiveWorkflowItemsBySandBoxId

@Transactional(value="blTransactionManager")
public void archiveWorkflowItemsBySandBoxId(Long sandBoxId)

Description copied from interface: WorkflowSandBoxItemService

Archive all WorkflowSandBoxItems associated to the given SandBox

Specified by:

archiveWorkflowItemsBySandBoxId in interface WorkflowSandBoxItemService

archiveWorkflowItemAndChildren

@Transactional(value="blTransactionManager")
public WorkflowSandBoxItem archiveWorkflowItemAndChildren(Long itemId)

Description copied from interface: WorkflowSandBoxItemService

Explicitly archive a WorkflowSandBoxItem and all its children (if applicable)

Specified by:

archiveWorkflowItemAndChildren in interface WorkflowSandBoxItemService

Returns:

the archived item

retrieveErrorMessage

public String retrieveErrorMessage(Long sandboxItemId)

Description copied from interface: WorkflowSandBoxItemService

Retrieves the latest error message for a given WorkflowSandBoxItem.

Specified by:

retrieveErrorMessage in interface WorkflowSandBoxItemService

Returns:

retrieveItemContainerLineage

public List<WorkflowSandBoxItem> retrieveItemContainerLineage(Long sandBoxItemId)

Description copied from interface: WorkflowSandBoxItemService

Retrieves the lineage of container items for a given WorkflowSandBoxItem's id

Specified by:

retrieveItemContainerLineage in interface WorkflowSandBoxItemService

retrieveItemContainerLineage

public List<WorkflowSandBoxItem> retrieveItemContainerLineage(WorkflowSandBoxItem sandBoxItem)

Description copied from interface: WorkflowSandBoxItemService

Retrieves the lineage of container items for a given WorkflowSandBoxItem

Specified by:

retrieveItemContainerLineage in interface WorkflowSandBoxItemService

retrieveSandboxItemsForEntityId

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

Description copied from interface: WorkflowSandBoxItemService

Retrieves the workflowSanboxItems targeting the passed in ID for the site

Specified by:

retrieveSandboxItemsForEntityId in interface WorkflowSandBoxItemService

Returns:

retrieveSandboxItemsForEntityIdIncludingArchived

public List<WorkflowSandBoxItem> retrieveSandboxItemsForEntityIdIncludingArchived(Long entityId,
                                                                                  String className,
                                                                                  Long siteId)

Description copied from interface: WorkflowSandBoxItemService

Retrieves the workflowSanboxItems targeting the passed in ID including archived records for the site

Specified by:

retrieveSandboxItemsForEntityIdIncludingArchived in interface WorkflowSandBoxItemService

siteId - @return

retrieveAllRelatedSandboxItemsForEntityIdIncludingArchived

public List<WorkflowSandBoxItem> retrieveAllRelatedSandboxItemsForEntityIdIncludingArchived(Long entityId,
                                                                                            String className,
                                                                                            Long siteId)

Description copied from interface: WorkflowSandBoxItemService

Retrieves all WorkflowSandBoxItem's related to the passed in ID including archived records for the site. Returns an WorkflowSandBoxItem found in a container related to the passed in entity ID

Specified by:

retrieveAllRelatedSandboxItemsForEntityIdIncludingArchived in interface WorkflowSandBoxItemService

siteId - @return

resetItemsForPromotion

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

Description copied from interface: WorkflowSandBoxItemService

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

Specified by:

resetItemsForPromotion in interface WorkflowSandBoxItemService

Returns:

clearItems

public int clearItems(List<Long> sandBoxItemIds)

Description copied from interface: WorkflowSandBoxItemService

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

Specified by:

clearItems in interface WorkflowSandBoxItemService

Returns:

retrieveWorkflowSandBoxItemsBySandBoxId

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

Specified by:

retrieveWorkflowSandBoxItemsBySandBoxId in interface WorkflowSandBoxItemService

retrieveSandboxItemsBySandboxOrigin

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

Description copied from interface: WorkflowSandBoxItemService

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

Specified by:

retrieveSandboxItemsBySandboxOrigin in interface WorkflowSandBoxItemService

Returns:

retrieveContainerSandboxItemsForPromotion

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

Description copied from interface: WorkflowSandBoxItemService

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 WorkflowSandBoxItemService

Returns: