org.opencms.ade.publish

类 CmsDirectPublishProject

java.lang.Object

org.opencms.ade.publish.CmsDirectPublishProject

所有已实现的接口:

I_CmsVirtualProject

public class CmsDirectPublishProject
extends java.lang.Object
implements I_CmsVirtualProject

Virtual project for 'direct publishing' of resources.

This virtual project gets the names of the resources to publish from the publish parameter map. If the 'add contents' mode is enabled (which is also determined from the publish parameters), the contents of folders are added to the list of publish resources. This virtual project is only available if any file names are passed via the

字段概要

字段

限定符和类型	字段和说明
static CmsUUID	ID The ID of this virtual project.

构造器概要

构造器

构造器和说明
CmsDirectPublishProject()

方法概要

方法

限定符和类型	方法和说明
protected void	addSubResources(CmsObject cms, java.util.Set<CmsResource> resources) Adds contents of folders to a list of resources.
CmsProjectBean	getProjectBean(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Gets the project bean.
CmsUUID	getProjectId() Gets the project id.
java.util.List<CmsResource>	getResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String workflowId) Gets the resources of the virtual project.
boolean	isAutoSelectable() Returns true if in this virtual project, resource groups should be able to be automatically selected by the GUI.
protected boolean	shouldIncludeContents(java.util.Map<java.lang.String,java.lang.String> params) Returns true if the folder contents should be included.

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

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

字段详细资料

ID

public static final CmsUUID ID

The ID of this virtual project.

构造器详细资料

CmsDirectPublishProject

public CmsDirectPublishProject()

方法详细资料

getProjectBean

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

从接口复制的说明: I_CmsVirtualProject

Gets the project bean.

Should return null if the virtual project is not available or applicable for the given parameters.

指定者:

getProjectBean 在接口中 I_CmsVirtualProject

参数:

cms - the CMS context to use

params - the publish parameters

返回:

the project bean

另请参阅:

I_CmsVirtualProject.getProjectBean(org.opencms.file.CmsObject, java.util.Map)

getProjectId

public CmsUUID getProjectId()

从接口复制的说明: I_CmsVirtualProject

Gets the project id.

指定者:

getProjectId 在接口中 I_CmsVirtualProject

返回:

the project id

另请参阅:

I_CmsVirtualProject.getProjectId()

getResources

public java.util.List<CmsResource> getResources(CmsObject cms,
                                       java.util.Map<java.lang.String,java.lang.String> params,
                                       java.lang.String workflowId)
                                         throws CmsException

从接口复制的说明: I_CmsVirtualProject

Gets the resources of the virtual project.

指定者:

getResources 在接口中 I_CmsVirtualProject

参数:

cms - the CMS context to use

params - the publish parameters

workflowId - the workflow id

返回:

the generated list of resources

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsVirtualProject.getResources(org.opencms.file.CmsObject, java.util.Map, java.lang.String)

isAutoSelectable

public boolean isAutoSelectable()

从接口复制的说明: I_CmsVirtualProject

Returns true if in this virtual project, resource groups should be able to be automatically selected by the GUI.

指定者:

isAutoSelectable 在接口中 I_CmsVirtualProject

返回:

true if resource groups should be auto-selectable

另请参阅:

I_CmsVirtualProject.isAutoSelectable()

addSubResources

protected void addSubResources(CmsObject cms,
                   java.util.Set<CmsResource> resources)
                        throws CmsException

Adds contents of folders to a list of resources.

参数:

cms - the CMS context to use

resources - the resource list to which to add the folder contents

抛出:

CmsException - if something goes wrong

shouldIncludeContents

protected boolean shouldIncludeContents(java.util.Map<java.lang.String,java.lang.String> params)

Returns true if the folder contents should be included.

参数:

params - the publish parameters

返回:

true if the folder contents should be included