Package org.alfresco.repo.workflow

Interface WorkflowPackageComponent

All Known Subinterfaces:

WorkflowPackageExtension, WorkflowPackageTrait

All Known Implementing Classes:

VirtualWorkflowPackageExtension, WorkflowPackageImpl

public interface WorkflowPackageComponent

Contract for managing Workflow Packages. A package is a container of Content that's routed through a Workflow.

Author:

davidc

Method Summary

Modifier and Type	Method	Description
NodeRef	createPackage(NodeRef container)	Create a Workflow Package (a container of content to route through the Workflow).
void	deletePackage(NodeRef container)	Deletes a Workflow Package The workflow package aspect is removed, and if the container was previously created by the workflow service (i.e. not provided from elsewhere), it will be deleted.
List<String>	getWorkflowIdsForContent(NodeRef packageItem)	Gets the Workflows that act upon the specified Repository content.
boolean	setWorkflowForPackage(WorkflowInstance instance)	Initialises the workflow package node on the WorkflowInstance, adding the appropriate aspect and setting the appropriate properties to mark it as a package for the given WorkflowInstance.

Method Details

createPackage

NodeRef createPackage(NodeRef container)

Create a Workflow Package (a container of content to route through the Workflow). If an existing container is supplied, it's supplemented with the workflow package aspect.

Parameters:

container - (optional) a pre-created container (e.g. folder, versioned folder or layered folder)

Returns:

the workflow package

deletePackage

void deletePackage(NodeRef container)

Deletes a Workflow Package The workflow package aspect is removed, and if the container was previously created by the workflow service (i.e. not provided from elsewhere), it will be deleted.

Parameters:

container - NodeRef

getWorkflowIdsForContent

List<String> getWorkflowIdsForContent(NodeRef packageItem)

Gets the Workflows that act upon the specified Repository content.

Parameters:

packageItem - the repository content item to get workflows for

Returns:

list of workflows which act upon the specified content

setWorkflowForPackage

boolean setWorkflowForPackage(WorkflowInstance instance)

Initialises the workflow package node on the WorkflowInstance, adding the appropriate aspect and setting the appropriate properties to mark it as a package for the given WorkflowInstance.

Parameters:

instance - the workflow instance to which the package belongs.

Returns:

true if the package node was modified.