org.opencms.ade.publish

类 CmsPublish

java.lang.Object

org.opencms.ade.publish.CmsPublish

public class CmsPublish
extends java.lang.Object

ADE publishing features.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
class	CmsPublish.ResourcesAndRelated Just for passing around resources and their related together but not mixed up.

字段概要

字段

限定符和类型	字段和说明
protected static int	GROUP_DAYS_NUMBER The number of day groups.
protected static int	GROUP_SESSIONS_GAP The gap between session groups.
protected static int	GROUP_SESSIONS_NUMBER The number of session groups.
protected CmsObject	m_cms The current cms context.
protected CmsPublishOptions	m_options The options.
protected java.util.Locale	m_workplaceLocale The current user workplace locale.

构造器概要

构造器

构造器和说明
CmsPublish(CmsObject cms) Creates a new instance.
CmsPublish(CmsObject cms, CmsPublishOptions options) Constructor with options.
CmsPublish(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Constructor with default options.

方法概要

方法

限定符和类型	方法和说明
java.util.List<CmsPublishResource>	getBrokenResources(java.util.List<CmsResource> pubResources) Checks for possible broken links when the given list of resources would be published.
protected static java.lang.String	getOuAwareName(CmsObject cms, java.lang.String name) Returns the simple name if the ou is the same as the current user's ou.
CmsRelationPublishValidator	getRelationValidator() Gets the relation validator instance.
void	publishResources(java.util.List<CmsResource> resources) Publishes the given list of resources.
CmsPublishResource	relationToBean(CmsRelation relation) Creates a publish resource bean from the target information of a relation object.
void	removeResourcesFromPublishList(java.util.Collection<CmsUUID> idsToRemove) Removes the given resources from the user's publish list.
protected CmsPublishResource	resourceToBean(CmsResource resource, CmsPublishResourceInfo info, boolean removable, java.util.List<CmsPublishResource> related) Creates a publish resource bean instance from the given parameters.

从类继承的方法 java.lang.Object

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

字段详细资料

GROUP_DAYS_NUMBER

protected static final int GROUP_DAYS_NUMBER

The number of day groups.

另请参阅:

常量字段值

GROUP_SESSIONS_GAP

protected static final int GROUP_SESSIONS_GAP

The gap between session groups.

另请参阅:

常量字段值

GROUP_SESSIONS_NUMBER

protected static final int GROUP_SESSIONS_NUMBER

The number of session groups.

另请参阅:

常量字段值

m_cms

protected final CmsObject m_cms

The current cms context.

m_options

protected final CmsPublishOptions m_options

The options.

m_workplaceLocale

protected final java.util.Locale m_workplaceLocale

The current user workplace locale.

构造器详细资料

CmsPublish

public CmsPublish(CmsObject cms)

Creates a new instance.

参数:

cms - the CMS context to use

CmsPublish

public CmsPublish(CmsObject cms,
          CmsPublishOptions options)

Constructor with options.

参数:

cms - the current cms context

options - the options to use

CmsPublish

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

Constructor with default options.

参数:

cms - the current cms context

params - the additional publish parameters

方法详细资料

getOuAwareName

protected static java.lang.String getOuAwareName(CmsObject cms,
                              java.lang.String name)

Returns the simple name if the ou is the same as the current user's ou.

参数:

cms - the CMS context

name - the fully qualified name to check

返回:

the simple name if the ou is the same as the current user's ou

getBrokenResources

public java.util.List<CmsPublishResource> getBrokenResources(java.util.List<CmsResource> pubResources)

Checks for possible broken links when the given list of resources would be published.

参数:

pubResources - list of resources to be published

返回:

a list of resources that would produce broken links when published

getRelationValidator

public CmsRelationPublishValidator getRelationValidator()

Gets the relation validator instance.

返回:

the relation validator

publishResources

public void publishResources(java.util.List<CmsResource> resources)
                      throws CmsException

Publishes the given list of resources.

参数:

resources - list of resources to publish

抛出:

CmsException - if something goes wrong

relationToBean

public CmsPublishResource relationToBean(CmsRelation relation)

Creates a publish resource bean from the target information of a relation object.

参数:

relation - the relation to use

返回:

the publish resource bean for the relation target

removeResourcesFromPublishList

public void removeResourcesFromPublishList(java.util.Collection<CmsUUID> idsToRemove)
                                    throws CmsException

Removes the given resources from the user's publish list.

参数:

idsToRemove - list of structure ids identifying the resources to be removed

抛出:

CmsException - if something goes wrong

resourceToBean

protected CmsPublishResource resourceToBean(CmsResource resource,
                                CmsPublishResourceInfo info,
                                boolean removable,
                                java.util.List<CmsPublishResource> related)

Creates a publish resource bean instance from the given parameters.

参数:

resource - the resource

info - the publish information, if any

removable - if removable

related - the list of related resources

返回:

the publish resource bean