Package org.opencms.ade.publish

Class CmsRealProjectVirtualWrapper

java.lang.Object

org.opencms.ade.publish.CmsRealProjectVirtualWrapper

All Implemented Interfaces:

I_CmsVirtualProject

Direct Known Subclasses:

CmsExtendedRealProjectWrapper

public class CmsRealProjectVirtualWrapper
extends java.lang.Object
implements I_CmsVirtualProject

Wrapper to use real OpenCms projects through the I_CmsVirtualProject interface.

Constructor Summary

Constructors

Constructor	Description
CmsRealProjectVirtualWrapper(CmsUUID id)	Creates a new wrapper instance.

Method Summary

Modifier and Type	Method	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsRealProjectVirtualWrapper

public CmsRealProjectVirtualWrapper(CmsUUID id)

Creates a new wrapper instance.

Parameters:

id - the project id

Method Detail

getProjectBean

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

Description copied from interface: I_CmsVirtualProject

Gets the project bean.

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

Specified by:

getProjectBean in interface I_CmsVirtualProject

Parameters:

cms - the CMS context to use

params - the publish parameters

Returns:

the project bean

See Also:

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

getProjectId

public CmsUUID getProjectId()

Description copied from interface: I_CmsVirtualProject

Gets the project id.

Specified by:

getProjectId in interface I_CmsVirtualProject

Returns:

the project id

See Also:

I_CmsVirtualProject.getProjectId()

getRelatedResourceProvider

public I_CmsPublishRelatedResourceProvider getRelatedResourceProvider(CmsObject cmsObject,
                                                                      CmsPublishOptions options)

Description copied from interface: I_CmsVirtualProject

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

Specified by:

getRelatedResourceProvider in interface I_CmsVirtualProject

Parameters:

cmsObject - the current CMS context

options - the publish options

Returns:

the related resource provider

See Also:

I_CmsVirtualProject.getRelatedResourceProvider(org.opencms.file.CmsObject, org.opencms.ade.publish.shared.CmsPublishOptions)

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

Description copied from interface: I_CmsVirtualProject

Gets the resources of the virtual project.

Specified by:

getResources in interface I_CmsVirtualProject

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

See Also:

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

isAutoSelectable

public boolean isAutoSelectable()

Description copied from interface: I_CmsVirtualProject

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

Specified by:

isAutoSelectable in interface I_CmsVirtualProject

Returns:

true if resource groups should be auto-selectable

See Also:

I_CmsVirtualProject.isAutoSelectable()