org.opencms.ade.publish

接口 I_CmsVirtualProject

所有已知实现类:

CmsCurrentPageProject, CmsDirectPublishProject, CmsExtendedRealProjectWrapper, CmsMyChangesProject, CmsRealProjectVirtualWrapper

public interface I_CmsVirtualProject

This interface can be used to implement a new option in the publish dialog's project selector. Instead of reading the resources from a real project, the resource lists will be generated by the classes which implement this interface.

方法概要

方法

限定符和类型	方法和说明
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.

方法详细资料

getProjectBean

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

Gets the project bean.

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

参数:

cms - the CMS context to use

params - the publish parameters

返回:

the project bean

getProjectId

CmsUUID getProjectId()

Gets the project id.

返回:

the project id

getResources

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

Gets the resources of the virtual project.

参数:

cms - the CMS context to use

params - the publish parameters

workflowId - the workflow id

返回:

the generated list of resources

抛出:

CmsException - if something goes wrong

isAutoSelectable

boolean isAutoSelectable()

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

返回:

true if resource groups should be auto-selectable