org.opencms.workflow
Class CmsRelease

java.lang.Object
  org.opencms.ade.publish.CmsPublish
      org.opencms.workflow.CmsRelease

public class CmsRelease
extends CmsPublish

A subclass of CmsPublish which builds resource lists for resources which can be released, rather than published.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.ade.publish.CmsPublish

CmsPublish.ResourcesAndRelated

Field Summary

protected static org.apache.commons.logging.Log

LOG The log object for this class.

Fields inherited from class org.opencms.ade.publish.CmsPublish

GROUP_DAYS_NUMBER, GROUP_SESSIONS_GAP, GROUP_SESSIONS_NUMBER, m_cms, m_options, m_workplaceLocale

Constructor Summary

CmsRelease(CmsObject cms)
Creates a new instance.

CmsRelease(CmsObject cms, CmsPublishOptions options)
Creates a new instance.

Method Summary

protected java.lang.String	getMessage(java.lang.String key, java.lang.String... args) Gets a message from the message bundle.
java.util.List<CmsPublishResource>	getPublishResourceBeans(CmsPublish.ResourcesAndRelated rawPublishResources) Gets the publish resources as a list of CmsPublishResource beans.
protected java.util.List<CmsResource>	getRawPublishResources() Gets the raw list of publish resources without any related resources or siblings.
protected CmsPublishResourceInfo	getResourceInfo(CmsResource resource, java.util.Set<CmsResource> published, CmsPublish.ResourcesAndRelated permissions, CmsPublish.ResourcesAndRelated locked) Returns the additional info for the given resource.

Methods inherited from class org.opencms.ade.publish.CmsPublish

addRelated, addSiblings, createPublishResource, getAlreadyPublishedResources, getBlockingLockedResources, getBrokenResources, getManageableProjects, getOptions, getOuAwareName, getPublishGroups, getPublishResourceBeans, getPublishResources, getPublishResourcesInternal, getRelatedResources, getResourceName, getResourcesWithoutPermissions, publishResources, relationToBean, removeResourcesFromPublishList, resourceToBean

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

The log object for this class.

Constructor Detail

CmsRelease

public CmsRelease(CmsObject cms)

Creates a new instance.

Parameters:

cms - the user CMS context

CmsRelease

public CmsRelease(CmsObject cms,
                  CmsPublishOptions options)

Creates a new instance.

Parameters:

cms - the user CMS context

options - the publish options

Method Detail

getPublishResourceBeans

public java.util.List<CmsPublishResource> getPublishResourceBeans(CmsPublish.ResourcesAndRelated rawPublishResources)

Description copied from class: CmsPublish

Gets the publish resources as a list of CmsPublishResource beans.

Overrides:

getPublishResourceBeans in class CmsPublish

Parameters:

rawPublishResources - the publish resources which should be converted to publish resource beans

Returns:

the publish resource beans

See Also:

CmsPublish.getPublishResourceBeans(org.opencms.ade.publish.CmsPublish.ResourcesAndRelated)

getMessage

protected java.lang.String getMessage(java.lang.String key,
                                      java.lang.String... args)

Gets a message from the message bundle.

Parameters:

key - the message key

args - the message parameters

Returns:

the message from the message bundle

getRawPublishResources

protected java.util.List<CmsResource> getRawPublishResources()
                                                      throws CmsException

Description copied from class: CmsPublish

Gets the raw list of publish resources without any related resources or siblings.

Overrides:

getRawPublishResources in class CmsPublish

Returns:

the raw list of publish resources

Throws:

CmsException - if something goes wrong

See Also:

CmsPublish.getRawPublishResources()

getResourceInfo

protected CmsPublishResourceInfo getResourceInfo(CmsResource resource,
                                                 java.util.Set<CmsResource> published,
                                                 CmsPublish.ResourcesAndRelated permissions,
                                                 CmsPublish.ResourcesAndRelated locked)

Description copied from class: CmsPublish

Returns the additional info for the given resource.

Overrides:

getResourceInfo in class CmsPublish

Parameters:

resource - the resource to use

published - the already published resources

permissions - the resource the current user does not have publish permissions for

locked - the locked resources

Returns:

the additional info for the given resource

See Also:

CmsPublish.getResourceInfo(org.opencms.file.CmsResource, java.util.Set, org.opencms.ade.publish.CmsPublish.ResourcesAndRelated, org.opencms.ade.publish.CmsPublish.ResourcesAndRelated)