org.opencms.workflow
Interface I_CmsWorkflowManager

All Known Implementing Classes:

A_CmsWorkflowManager, CmsDefaultWorkflowManager, CmsExtendedWorkflowManager

public interface I_CmsWorkflowManager

Workflow manager interface.

Method Summary

CmsWorkflowResponse	executeAction(CmsObject userCms, CmsWorkflowAction action, CmsPublishOptions options, java.util.List<CmsResource> resources) Executes a workflow action in the context of the current user.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Gets the parameters of the workflow manager.
java.util.List<CmsPublishResource>	getWorkflowPublishResources(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options) Returns the publish resource beans for the given workflow and project.
java.util.List<CmsResource>	getWorkflowResources(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options) Returns the resources for the given workflow and project.
java.util.Map<java.lang.String,CmsWorkflow>	getWorkflows(CmsObject cms) Returns the available workflows for the current user.
void	initialize(CmsObject adminCms) Initializes this workflow manager instance.
void	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Sets the configuration parameters of the workflow manager.

Method Detail

executeAction

CmsWorkflowResponse executeAction(CmsObject userCms,
                                  CmsWorkflowAction action,
                                  CmsPublishOptions options,
                                  java.util.List<CmsResource> resources)
                                  throws CmsException

Executes a workflow action in the context of the current user.

Parameters:

userCms - the current user's CMS context

action - the workflow action

options - the publish options

resources - the resources to be processed

Returns:

the workflow response for the executed action

Throws:

CmsException - if something goes wrong

getParameters

java.util.Map<java.lang.String,java.lang.String> getParameters()

Gets the parameters of the workflow manager.

Returns:

the configuration parameters of the workflow manager

getWorkflowPublishResources

java.util.List<CmsPublishResource> getWorkflowPublishResources(CmsObject cms,
                                                               CmsWorkflow workflow,
                                                               CmsPublishOptions options)

Returns the publish resource beans for the given workflow and project.

Parameters:

cms - the user cms context

workflow - the workflow

options - the resource options

Returns:

the workflow publish resource beans

getWorkflowResources

java.util.List<CmsResource> getWorkflowResources(CmsObject cms,
                                                 CmsWorkflow workflow,
                                                 CmsPublishOptions options)

Returns the resources for the given workflow and project.

Parameters:

cms - the user cms context

workflow - the workflow

options - the resource options

Returns:

the workflow resources

getWorkflows

java.util.Map<java.lang.String,CmsWorkflow> getWorkflows(CmsObject cms)

Returns the available workflows for the current user.

Parameters:

cms - the user cms context

Returns:

the available workflows

initialize

void initialize(CmsObject adminCms)

Initializes this workflow manager instance.

Parameters:

adminCms - the CMS context with admin privileges

setParameters

void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Sets the configuration parameters of the workflow manager.

Parameters:

parameters - the map of configuration parameters