Package com.broadleafcommerce.enterprise.workflow.admin.service

Interface PurgeSandboxWorkflowEntitiesService

All Known Implementing Classes:

PurgeSandboxWorkflowEntitiesServiceImpl

public interface PurgeSandboxWorkflowEntitiesService

A service to aid in retrieving and removing WorkflowSandBoxItems and its related entities

Author:

Jay Aisenbrey (cja769)

Method Summary

Modifier and Type	Method	Description
int	batchRemoveApprovals()	Removes all orphaned ApprovalDetailss
int	batchRemoveDeployments(Date expiryDate)	Removes all orphaned WorkflowDeployments
int	batchRemoveEntityItems(Set<Long> entityItems)	Removes the EntityItems for the given entity item ids
int	batchRemovePromotions()	Removes all orphaned PromotionDetailss
int	batchRemoveWorkflowEvents(Date expiryDate)	Removes all orphaned WorkflowEvents
int	batchRemoveWorkflowSandBoxDTO(PurgeSandboxWorkflowBatchDTO batchDTO)	Purges all records per the provided PurgeSandboxWorkflowBatchDTO.
int	batchRemoveWorkflowSandBoxEventItems(Set<Long> workflowIds)	Removes WorkflowEventWorkflowItemXref where the item id is in the given set of longs
int	batchRemoveWorkflowSandBoxItems(Set<Long> workflowIds)	Removes the WorkflowSandBoxItems for the given ids
List<WorkflowSandBoxItem>	findArchivedParentWorkflowSandBoxItems(Set<Long> itemsToIgnore, Date expiryDate, int maxResults, boolean filterSiteOverrides)	Retrieves the WorkflowSandBoxItems that are archived, are older than expiryDate, whose id isn't in itemsToIgnore, and doesn't have a WorkflowSandBoxItem that depend on them.
EntityItem	findEntityItemByWorkflowSandBoxItem(WorkflowSandBoxItem item)	Returns the EntityItem, if it exists, for the given WorkflowSandBoxItem
WorkflowEvent	findWorkflowEventByWorkflowSandBoxItem(WorkflowSandBoxItem item)	Returns the WorkflowEvent, if it exists, for the given WorkflowSandBoxItem
WorkflowSandBoxItem	findWorkflowSandBoxItemById(Long id)	Finds the WorkflowSandBoxItem by the given id;
WorkflowSandBoxItem	saveWorkflowSandBoxItem(WorkflowSandBoxItem item)	Saves the given WorkflowSandBoxItem.

Method Details

findArchivedParentWorkflowSandBoxItems

List<WorkflowSandBoxItem> findArchivedParentWorkflowSandBoxItems(Set<Long> itemsToIgnore,
 Date expiryDate,
 int maxResults,
 boolean filterSiteOverrides)

Retrieves the WorkflowSandBoxItems that are archived, are older than expiryDate, whose id isn't in itemsToIgnore, and doesn't have a WorkflowSandBoxItem that depend on them. Additionally the filterSiteOverrides parameter dictates if we should return WorkflowSandBoxItems that are for a site override.

Parameters:

itemsToIgnore - A set of longs that indicate the WorkflowSandBoxItem ids that should not filtered out from the result set

expiryDate - The most recent Date of an archived WorkflowSandBoxItem that shoudl be returned

maxResults - The maximum number of results that should be returned

filterSiteOverrides - A boolean indicating if WorkflowSandBoxItem for site overrides should be returned. If true then they will filtered; else they will be included in the result

Returns:

A List of WorkflowSandBoxItems that meet the given criteria

findWorkflowEventByWorkflowSandBoxItem

WorkflowEvent findWorkflowEventByWorkflowSandBoxItem(WorkflowSandBoxItem item)

Returns the WorkflowEvent, if it exists, for the given WorkflowSandBoxItem

Parameters:

item - The WorkflowSandBoxItem to find the WorkflowEvent for

Returns:

The corresponding WorkflowEvent for the given WorkflowSandBoxItem

findEntityItemByWorkflowSandBoxItem

EntityItem findEntityItemByWorkflowSandBoxItem(WorkflowSandBoxItem item)

Returns the EntityItem, if it exists, for the given WorkflowSandBoxItem

Parameters:

item - The WorkflowSandBoxItem to find the EntityItem for

Returns:

The corresponding EntityItem for the given WorkflowSandBoxItem

saveWorkflowSandBoxItem

WorkflowSandBoxItem saveWorkflowSandBoxItem(WorkflowSandBoxItem item)

Saves the given WorkflowSandBoxItem. This is usually used to save changes to the dependent items so we don't have to manually delete from that xref table

Parameters:

item - The WorkflowSandBoxItem to save

Returns:

The WorkflowSandBoxItem after it's persisted

findWorkflowSandBoxItemById

WorkflowSandBoxItem findWorkflowSandBoxItemById(Long id)

Finds the WorkflowSandBoxItem by the given id;

Parameters:

id - The id to find the WorkflowSandBoxItem by

Returns:

The WorkflowSandBoxItem that was found

batchRemoveWorkflowSandBoxEventItems

int batchRemoveWorkflowSandBoxEventItems(Set<Long> workflowIds)

Removes WorkflowEventWorkflowItemXref where the item id is in the given set of longs

Parameters:

workflowIds - The WorkflowSandBoxItem ids whose WorkflowEventWorkflowItemXrefs should be removed for

Returns:

The number of records deleted

batchRemoveEntityItems

int batchRemoveEntityItems(Set<Long> entityItems)

Removes the EntityItems for the given entity item ids

Parameters:

entityItems - The EntityItem ids to use for removal

Returns:

The number of records deleted

batchRemoveWorkflowSandBoxItems

int batchRemoveWorkflowSandBoxItems(Set<Long> workflowIds)

Removes the WorkflowSandBoxItems for the given ids

Parameters:

workflowIds - The ids for the WorkflowSandBoxItems that should be removed

Returns:

The number of records deleted

batchRemoveWorkflowEvents

int batchRemoveWorkflowEvents(Date expiryDate)

Removes all orphaned WorkflowEvents

Parameters:

expiryDate - is a limit of time to perform the Remove

Returns:

The number of records deleted

batchRemoveDeployments

int batchRemoveDeployments(Date expiryDate)

Removes all orphaned WorkflowDeployments

Parameters:

expiryDate - is a limit of time to perform the Remove

Returns:

The number of records deleted

batchRemoveApprovals

int batchRemoveApprovals()

Removes all orphaned ApprovalDetailss

Returns:

The number of records deleted

batchRemovePromotions

int batchRemovePromotions()

Removes all orphaned PromotionDetailss

Returns:

The number of records deleted

batchRemoveWorkflowSandBoxDTO

int batchRemoveWorkflowSandBoxDTO(PurgeSandboxWorkflowBatchDTO batchDTO)

Purges all records per the provided PurgeSandboxWorkflowBatchDTO. Generally this indicates a purge of one or more WorkflowSandBoxItems

Parameters:

batchDTO - The PurgeSandboxWorkflowBatchDTO used for deletion

Returns:

The number of records deleted