org.opencms.workflow

类 CmsDefaultWorkflowManager

java.lang.Object

org.opencms.workflow.A_CmsWorkflowManager

org.opencms.workflow.CmsDefaultWorkflowManager

所有已实现的接口:

I_CmsWorkflowManager

直接已知子类:

CmsExtendedWorkflowManager

public class CmsDefaultWorkflowManager
extends A_CmsWorkflowManager

The default implementation of the workflow manager interface, which offers only publish functionality.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	ACTION_FORCE_PUBLISH The forced publish workflow action.
static java.lang.String	ACTION_PUBLISH The publish workflow action.
static int	DEFAULT_RESOURCE_LIMIT Default value for the maximum number of resources in the initial publish list.
protected java.util.Map<CmsUUID,I_CmsVirtualProject>	m_virtualProjects The map of registered virtual projects.
static java.lang.String	PARAM_RESOURCE_LIMIT The parameter name for the resource limit.
static java.lang.String	WORKFLOW_PUBLISH The name for the publish action.

从类继承的字段 org.opencms.workflow.A_CmsWorkflowManager

m_adminCms, m_parameters

构造器概要

构造器

构造器和说明
CmsDefaultWorkflowManager() Constructor.

方法概要

方法

限定符和类型	方法和说明
protected CmsWorkflowResponse	actionForcePublish(CmsObject userCms, CmsPublishOptions options, java.util.List<CmsResource> resources) The implementation of the "forcepublish" workflow action.
protected CmsWorkflowResponse	actionPublish(CmsObject userCms, CmsPublishOptions options, java.util.List<CmsResource> resources) The implementation of the "publish" workflow action.
I_CmsPublishResourceFormatter	createFormatter(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options) Creates the formatter for formatting the resources to be displayed to the user.
static CmsProjectBean	createProjectBeanFromProject(CmsObject cms, CmsProject project) Creates a project bean from a real project.
CmsWorkflowResponse	executeAction(CmsObject cms, CmsWorkflowAction action, CmsPublishListToken token) Executes a workflow action for a publish list token instead of a resource list.
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.lang.String	getLabel(CmsObject cms, java.lang.String key) Gets the localized label for a given CMS context and key.
java.util.List<CmsProjectBean>	getManageableProjects(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Returns the current user's manageable projects.
protected static java.lang.String	getOuAwareName(CmsObject cms, java.lang.String name) Returns the simple name if the ou is the same as the current user's ou.
CmsPublishListToken	getPublishListToken(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options) Gets a publish list token for the given parameters which can be used later to reconstruct the publish list.
I_CmsVirtualProject	getRealOrVirtualProject(CmsUUID projectId) Gets the virtual project object identified by the given id.
int	getResourceLimit() Gets the resource limit.
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.

从类继承的方法 org.opencms.workflow.A_CmsWorkflowManager

getLocale, getParameter, getParameters, setParameters

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

ACTION_FORCE_PUBLISH

public static final java.lang.String ACTION_FORCE_PUBLISH

The forced publish workflow action.

另请参阅:

常量字段值

ACTION_PUBLISH

public static final java.lang.String ACTION_PUBLISH

The publish workflow action.

另请参阅:

常量字段值

DEFAULT_RESOURCE_LIMIT

public static int DEFAULT_RESOURCE_LIMIT

Default value for the maximum number of resources in the initial publish list.

PARAM_RESOURCE_LIMIT

public static final java.lang.String PARAM_RESOURCE_LIMIT

The parameter name for the resource limit.

另请参阅:

常量字段值

WORKFLOW_PUBLISH

public static final java.lang.String WORKFLOW_PUBLISH

The name for the publish action.

另请参阅:

常量字段值

m_virtualProjects

protected java.util.Map<CmsUUID,I_CmsVirtualProject> m_virtualProjects

The map of registered virtual projects.

构造器详细资料

CmsDefaultWorkflowManager

public CmsDefaultWorkflowManager()

Constructor.

方法详细资料

createProjectBeanFromProject

public static CmsProjectBean createProjectBeanFromProject(CmsObject cms,
                                          CmsProject project)

Creates a project bean from a real project.

参数:

cms - the CMS context

project - the project

返回:

the bean containing the project information

getOuAwareName

protected static java.lang.String getOuAwareName(CmsObject cms,
                              java.lang.String name)

Returns the simple name if the ou is the same as the current user's ou.

参数:

cms - the CMS context

name - the fully qualified name to check

返回:

the simple name if the ou is the same as the current user's ou

createFormatter

public I_CmsPublishResourceFormatter createFormatter(CmsObject cms,
                                            CmsWorkflow workflow,
                                            CmsPublishOptions options)

从接口复制的说明: I_CmsWorkflowManager

Creates the formatter for formatting the resources to be displayed to the user.

参数:

cms - the CMS context to use

workflow - the current workflow

options - the publish options

返回:

the publish resource formatter to use

另请参阅:

I_CmsWorkflowManager.createFormatter(org.opencms.file.CmsObject, org.opencms.ade.publish.shared.CmsWorkflow, org.opencms.ade.publish.shared.CmsPublishOptions)

executeAction

public CmsWorkflowResponse executeAction(CmsObject cms,
                                CmsWorkflowAction action,
                                CmsPublishListToken token)
                                  throws CmsException

从接口复制的说明: I_CmsWorkflowManager

Executes a workflow action for a publish list token instead of a resource list.

参数:

cms - the CMS context to use

action - the action to perform

token - the publish list token to use

返回:

the workflow response

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsWorkflowManager.executeAction(org.opencms.file.CmsObject, org.opencms.ade.publish.shared.CmsWorkflowAction, org.opencms.ade.publish.shared.CmsPublishListToken)

executeAction

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

从接口复制的说明: I_CmsWorkflowManager

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

参数:

userCms - the current user's CMS context

action - the workflow action

options - the publish options

resources - the resources to be processed

返回:

the workflow response for the executed action

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsWorkflowManager.executeAction(org.opencms.file.CmsObject, org.opencms.ade.publish.shared.CmsWorkflowAction, org.opencms.ade.publish.shared.CmsPublishOptions, java.util.List)

getLabel

public java.lang.String getLabel(CmsObject cms,
                        java.lang.String key)

Gets the localized label for a given CMS context and key.

参数:

cms - the CMS context

key - the localization key

返回:

the localized label

getManageableProjects

public java.util.List<CmsProjectBean> getManageableProjects(CmsObject cms,
                                                   java.util.Map<java.lang.String,java.lang.String> params)

从接口复制的说明: I_CmsWorkflowManager

Returns the current user's manageable projects.

参数:

cms - the CMS context to use

params - the publish parameters

返回:

the current user's manageable projects

另请参阅:

I_CmsWorkflowManager.getManageableProjects(org.opencms.file.CmsObject, java.util.Map)

getPublishListToken

public CmsPublishListToken getPublishListToken(CmsObject cms,
                                      CmsWorkflow workflow,
                                      CmsPublishOptions options)

从接口复制的说明: I_CmsWorkflowManager

Gets a publish list token for the given parameters which can be used later to reconstruct the publish list.

参数:

cms - the CMS context to use

workflow - the workflow

options - the publish options

返回:

the publish list token

另请参阅:

I_CmsWorkflowManager.getPublishListToken(org.opencms.file.CmsObject, org.opencms.ade.publish.shared.CmsWorkflow, org.opencms.ade.publish.shared.CmsPublishOptions)

getRealOrVirtualProject

public I_CmsVirtualProject getRealOrVirtualProject(CmsUUID projectId)

从接口复制的说明: I_CmsWorkflowManager

Gets the virtual project object identified by the given id.

参数:

projectId - the virtual project id

返回:

the virtual project object

另请参阅:

I_CmsWorkflowManager.getRealOrVirtualProject(org.opencms.util.CmsUUID)

getResourceLimit

public int getResourceLimit()

从接口复制的说明: I_CmsWorkflowManager

Gets the resource limit.

Publish lists which exceed this limit (counted before adding any related resources, siblings etc.) are not displayed to the user.

返回:

the resource limit

另请参阅:

I_CmsWorkflowManager.getResourceLimit()

getWorkflowResources

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

从接口复制的说明: I_CmsWorkflowManager

Returns the resources for the given workflow and project.

参数:

cms - the user cms context

workflow - the workflow

options - the resource options

返回:

the workflow resources

另请参阅:

I_CmsWorkflowManager.getWorkflowResources(org.opencms.file.CmsObject, org.opencms.ade.publish.shared.CmsWorkflow, org.opencms.ade.publish.shared.CmsPublishOptions)

getWorkflows

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

从接口复制的说明: I_CmsWorkflowManager

Returns the available workflows for the current user.

参数:

cms - the user cms context

返回:

the available workflows

另请参阅:

I_CmsWorkflowManager.getWorkflows(org.opencms.file.CmsObject)

initialize

public void initialize(CmsObject adminCms)

从接口复制的说明: I_CmsWorkflowManager

Initializes this workflow manager instance.

指定者:

initialize 在接口中 I_CmsWorkflowManager

覆盖:

initialize 在类中 A_CmsWorkflowManager

参数:

adminCms - the CMS context with admin privileges

另请参阅:

A_CmsWorkflowManager.initialize(org.opencms.file.CmsObject)

actionForcePublish

protected CmsWorkflowResponse actionForcePublish(CmsObject userCms,
                                     CmsPublishOptions options,
                                     java.util.List<CmsResource> resources)
                                          throws CmsException

The implementation of the "forcepublish" workflow action.

参数:

userCms - the user CMS context

resources - the resources which the action should process

options - the publish options to use

返回:

the workflow response

抛出:

CmsException - if something goes wrong

actionPublish

protected CmsWorkflowResponse actionPublish(CmsObject userCms,
                                CmsPublishOptions options,
                                java.util.List<CmsResource> resources)
                                     throws CmsException

The implementation of the "publish" workflow action.

参数:

userCms - the user CMS context

options - the publish options

resources - the resources which the action should process

返回:

the workflow response

抛出:

CmsException - if something goes wrong