org.opencms.ade.publish

Interface I_CmsVirtualProject

All Known Implementing Classes:

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.

Method Summary

Modifier and Type	Method and Description
CmsProjectBean	getProjectBean(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Gets the project bean.
CmsUUID	getProjectId() Gets the project id.
I_CmsPublishRelatedResourceProvider	getRelatedResourceProvider(CmsObject cmsObject, CmsPublishOptions options) Returns an object that can be queried for 'related' resources specific to this virtual project.
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.

Method Detail

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.

Parameters:

cms - the CMS context to use

params - the publish parameters

Returns:

the project bean

getProjectId

CmsUUID getProjectId()

Gets the project id.

Returns:

the project id

getRelatedResourceProvider

I_CmsPublishRelatedResourceProvider getRelatedResourceProvider(CmsObject cmsObject,
                                                               CmsPublishOptions options)

Returns an object that can be queried for 'related' resources specific to this virtual project.

Parameters:

cmsObject - the current CMS context

options - the publish options

Returns:

the related resource provider

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.

Parameters:

cms - the CMS context to use

params - the publish parameters

workflowId - the workflow id

Returns:

the generated list of resources

Throws:

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.

Returns:

true if resource groups should be auto-selectable