Package com.comalatech.workflow.template

Interface WorkflowTemplateManager

public interface WorkflowTemplateManager

Manage workflow templates

Method Summary

Modifier and Type	Method	Description
void	activateGlobalTemplate(String workflowName)	Activate global workflow template so it can be applied to spaces or pages.
void	addWorkflowTemplate(com.atlassian.confluence.spaces.Space space, String workflowMarkup)	Adds a workflow template to a space
void	copyGlobalTemplate(String workflowName)	Copies a global workflow template
void	deactivateGlobalTemplate(String workflowName)	Deactivate global workflow template so it can't be applied to spaces or pages.
List<Workflow>	getWorkflowTemplates()	Returns the global workflow templates
List<Workflow>	getWorkflowTemplates(com.atlassian.confluence.spaces.Space space)	Returns the workflow templates for a given space
void	removeWorkflowTemplate(com.atlassian.confluence.spaces.Space space, String workflowName)	Removes a workflow template from a space.

Method Detail

getWorkflowTemplates

List<Workflow> getWorkflowTemplates()

Returns the global workflow templates

Returns:

a list of workflows templates that are set globally

getWorkflowTemplates

List<Workflow> getWorkflowTemplates(com.atlassian.confluence.spaces.Space space)

Returns the workflow templates for a given space

Parameters:

space - the space to get the workflow templates for

Returns:

a list of workflow templates that are set on the given space.

addWorkflowTemplate

void addWorkflowTemplate(com.atlassian.confluence.spaces.Space space,
                         String workflowMarkup)
                  throws WorkflowException

Adds a workflow template to a space

Parameters:

space - the space to add the workflow template to

workflowMarkup - the workflow markup to add

Throws:

WorkflowException - if there was an error with the workflow markup

removeWorkflowTemplate

void removeWorkflowTemplate(com.atlassian.confluence.spaces.Space space,
                            String workflowName)

Removes a workflow template from a space.

Parameters:

space - the space to remove the workflow template from

workflowName - the name of the workflow to remove

copyGlobalTemplate

void copyGlobalTemplate(String workflowName)

Copies a global workflow template

Parameters:

workflowName - the name of the workflow to copy

deactivateGlobalTemplate

void deactivateGlobalTemplate(String workflowName)
                       throws WorkflowException

Deactivate global workflow template so it can't be applied to spaces or pages.

Parameters:

workflowName - the name of the workflow to deactivate

Throws:

WorkflowException

activateGlobalTemplate

void activateGlobalTemplate(String workflowName)
                     throws WorkflowException

Activate global workflow template so it can be applied to spaces or pages.

Parameters:

workflowName - the name of the workflow to activate

Throws:

WorkflowException