com.adobe.acs.commons.workflow.bulk.removal

Interface WorkflowInstanceRemover

public interface WorkflowInstanceRemover

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODEL_ID
static String	WORKFLOW_INSTANCES_PATH Deprecated. please use the multi-value WORKFLOW_INSTANCES_PATHS instead.
static String[]	WORKFLOW_INSTANCES_PATHS

Method Summary

Modifier and Type	Method and Description
void	forceQuit() Forces an interruption of the Workflow removal process.
WorkflowRemovalStatus	getStatus() Gets the Workflow Remover's status.
int	removeWorkflowInstances(org.apache.sling.api.resource.ResourceResolver resourceResolver, Collection<String> modelIds, Collection<String> statuses, Collection<Pattern> payloads, Calendar olderThan) Removes workflow instances that match the parameter criteria.
int	removeWorkflowInstances(org.apache.sling.api.resource.ResourceResolver resourceResolver, Collection<String> modelIds, Collection<String> statuses, Collection<Pattern> payloads, Calendar olderThan, int batchSize) Removes workflow instances that match the parameter criteria.
int	removeWorkflowInstances(org.apache.sling.api.resource.ResourceResolver resourceResolver, Collection<String> modelIds, Collection<String> statuses, Collection<Pattern> payloads, Calendar olderThan, int batchSize, int maxDurationInMins) Removes workflow instances that match the parameter criteria.

Field Detail

WORKFLOW_INSTANCES_PATH

@Deprecated
static final String WORKFLOW_INSTANCES_PATH

Deprecated. please use the multi-value WORKFLOW_INSTANCES_PATHS instead.

See Also:

Constant Field Values

WORKFLOW_INSTANCES_PATHS

static final String[] WORKFLOW_INSTANCES_PATHS

MODEL_ID

static final String MODEL_ID

See Also:

Constant Field Values

Method Detail

removeWorkflowInstances

int removeWorkflowInstances(org.apache.sling.api.resource.ResourceResolver resourceResolver,
                            Collection<String> modelIds,
                            Collection<String> statuses,
                            Collection<Pattern> payloads,
                            Calendar olderThan)
                     throws org.apache.sling.api.resource.PersistenceException,
                            WorkflowRemovalException,
                            InterruptedException,
                            WorkflowRemovalForceQuitException

Removes workflow instances that match the parameter criteria.

Parameters:

resourceResolver - the resource resolver; must have access to read/delete workflow instances

modelIds - WF Models to remove

statuses - WF Statuses to remove

payloads - Regexes; WF Payloads to remove

olderThan - UTC time in milliseconds; only delete WF's started after this time

Returns:

the number of WF instances removed

Throws:

org.apache.sling.api.resource.PersistenceException

WorkflowRemovalException

InterruptedException

WorkflowRemovalForceQuitException

removeWorkflowInstances

int removeWorkflowInstances(org.apache.sling.api.resource.ResourceResolver resourceResolver,
                            Collection<String> modelIds,
                            Collection<String> statuses,
                            Collection<Pattern> payloads,
                            Calendar olderThan,
                            int batchSize)
                     throws org.apache.sling.api.resource.PersistenceException,
                            WorkflowRemovalException,
                            InterruptedException,
                            WorkflowRemovalForceQuitException

Removes workflow instances that match the parameter criteria.

Parameters:

resourceResolver - the resource resolver; must have access to read/delete workflow instances

modelIds - WF Models to remove

statuses - WF Statuses to remove

payloads - Regexes; WF Payloads to remove

olderThan - UTC time in milliseconds; only delete WF's started after this time

batchSize - number of workflow instances to delete per JCR save

Returns:

the number of WF instances removed

Throws:

org.apache.sling.api.resource.PersistenceException

WorkflowRemovalException

InterruptedException

WorkflowRemovalForceQuitException

removeWorkflowInstances

int removeWorkflowInstances(org.apache.sling.api.resource.ResourceResolver resourceResolver,
                            Collection<String> modelIds,
                            Collection<String> statuses,
                            Collection<Pattern> payloads,
                            Calendar olderThan,
                            int batchSize,
                            int maxDurationInMins)
                     throws org.apache.sling.api.resource.PersistenceException,
                            WorkflowRemovalException,
                            InterruptedException,
                            WorkflowRemovalForceQuitException

Removes workflow instances that match the parameter criteria.

Parameters:

resourceResolver - the resource resolver; must have access to read/delete workflow instances

modelIds - WF Models to remove

statuses - WF Statuses to remove

payloads - Regexes; WF Payloads to remove

olderThan - UTC time in milliseconds; only delete WF's started after this time

batchSize - number of workflow instances to delete per JCR save

maxDurationInMins - max number of mins the workflow removal process is allowed to run

Returns:

the number of WF instances removed

Throws:

org.apache.sling.api.resource.PersistenceException

WorkflowRemovalException

InterruptedException

WorkflowRemovalForceQuitException

getStatus

WorkflowRemovalStatus getStatus()

Gets the Workflow Remover's status. *

Returns:

the workflow remover's status object

forceQuit

void forceQuit()

Forces an interruption of the Workflow removal process. Any uncommited changes will be lost.