org.opencms.ade.publish.shared

类 CmsPublishOptions

java.lang.Object

org.opencms.ade.publish.shared.CmsPublishOptions

所有已实现的接口:

java.io.Serializable

public class CmsPublishOptions
extends java.lang.Object
implements java.io.Serializable

Bean encapsulating all ADE publish options.

从以下版本开始:

7.6

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	PARAM_CONTAINERPAGE Parameter name for the container page structure id.
static java.lang.String	PARAM_CONTENT Parameter name for the content structure id.
static java.lang.String	PARAM_DETAIL Parameter name for the detail content structure id.
static java.lang.String	PARAM_ENABLE_INCLUDE_CONTENTS Parameter for enabling the 'add contents' check box.
static java.lang.String	PARAM_FILES The name of the parameter used for passing in the list of resources.
static java.lang.String	PARAM_INCLUDE_CONTENTS The name of the parameter which controls whether to add sub-resources of folders.
static java.lang.String	PARAM_START_WITH_CURRENT_PAGE Parameter for indicating that the initial project should be the 'current page' virtual project.

构造器概要

构造器

构造器和说明
CmsPublishOptions() Creates a new publish options bean.
CmsPublishOptions(boolean includeRelated, boolean includeSiblings, CmsUUID projectId) Creates a new publish options bean.
CmsPublishOptions(java.util.Map<java.lang.String,java.lang.String> params) Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
java.util.Map<java.lang.String,java.lang.String>	getParameters() Gets the additional publish parameters.
CmsUUID	getProjectId() Returns the project id.
boolean	isIncludeRelated() Checks if to include related resources.
boolean	isIncludeSiblings() Checks if to include siblings.
void	setIncludeRelated(boolean includeRelated) Sets the flag to include related resources.
void	setIncludeSiblings(boolean includeSiblings) Sets the flag to include siblings.
void	setParameters(java.util.Map<java.lang.String,java.lang.String> params) Sets the additional publish parameters.
void	setProjectId(CmsUUID projectId) Sets the id of the project to publish.

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

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

字段详细资料

PARAM_CONTAINERPAGE

public static final java.lang.String PARAM_CONTAINERPAGE

Parameter name for the container page structure id.

另请参阅:

常量字段值

PARAM_CONTENT

public static final java.lang.String PARAM_CONTENT

Parameter name for the content structure id.

另请参阅:

常量字段值

PARAM_DETAIL

public static final java.lang.String PARAM_DETAIL

Parameter name for the detail content structure id.

另请参阅:

常量字段值

PARAM_ENABLE_INCLUDE_CONTENTS

public static final java.lang.String PARAM_ENABLE_INCLUDE_CONTENTS

Parameter for enabling the 'add contents' check box.

另请参阅:

常量字段值

PARAM_FILES

public static final java.lang.String PARAM_FILES

The name of the parameter used for passing in the list of resources.

另请参阅:

常量字段值

PARAM_INCLUDE_CONTENTS

public static final java.lang.String PARAM_INCLUDE_CONTENTS

The name of the parameter which controls whether to add sub-resources of folders.

另请参阅:

常量字段值

PARAM_START_WITH_CURRENT_PAGE

public static final java.lang.String PARAM_START_WITH_CURRENT_PAGE

Parameter for indicating that the initial project should be the 'current page' virtual project.

另请参阅:

常量字段值

构造器详细资料

CmsPublishOptions

public CmsPublishOptions()

Creates a new publish options bean.

CmsPublishOptions

public CmsPublishOptions(boolean includeRelated,
                 boolean includeSiblings,
                 CmsUUID projectId)

Creates a new publish options bean.

参数:

includeRelated - Flag to include related resources

includeSiblings - Flag to include siblings

projectId - The id of the project to publish

CmsPublishOptions

public CmsPublishOptions(java.util.Map<java.lang.String,java.lang.String> params)

Creates a new instance.

参数:

params - the additional publish parameters

方法详细资料

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Gets the additional publish parameters.

返回:

the additional publish parameters

getProjectId

public CmsUUID getProjectId()

Returns the project id.

返回:

the project id

isIncludeRelated

public boolean isIncludeRelated()

Checks if to include related resources.

返回:

true if to include related resources

isIncludeSiblings

public boolean isIncludeSiblings()

Checks if to include siblings.

返回:

true if to include siblings

setIncludeRelated

public void setIncludeRelated(boolean includeRelated)

Sets the flag to include related resources.

参数:

includeRelated - the flag to set

setIncludeSiblings

public void setIncludeSiblings(boolean includeSiblings)

Sets the flag to include siblings.

参数:

includeSiblings - the flag to set

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> params)

Sets the additional publish parameters.

参数:

params - the additional parameters to set

setProjectId

public void setProjectId(CmsUUID projectId)

Sets the id of the project to publish.

参数:

projectId - the id to set