org.opencms.workflow
Class CmsExtendedPublish

java.lang.Object
  extended by org.opencms.ade.publish.CmsPublish
      extended by org.opencms.workflow.CmsExtendedPublish

public class CmsExtendedPublish
extends CmsPublish

A publish class which adds workflow-related error messages.


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 logger instance 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
CmsExtendedPublish(CmsObject cms)
          Creates a new instance.
CmsExtendedPublish(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.
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, getPublishResourceBeans, getPublishResources, getPublishResourcesInternal, getRawPublishResources, 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 logger instance for this class.

Constructor Detail

CmsExtendedPublish

public CmsExtendedPublish(CmsObject cms)
Creates a new instance.

Parameters:
cms - the CMS context

CmsExtendedPublish

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

Parameters:
cms - the CMS context
options - the publish options
Method Detail

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

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)