org.opencms.ade.publish.shared
Class CmsPublishOptions

java.lang.Object
  org.opencms.ade.publish.shared.CmsPublishOptions

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class CmsPublishOptions
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable

Bean encapsulating all ADE publish options.

Since:

7.6

Constructor Summary

CmsPublishOptions()
Creates a new publish options bean.

CmsPublishOptions(boolean includeRelated, boolean includeSiblings, CmsUUID projectId)
Creates a new publish options bean.

Method Summary

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	setProjectId(CmsUUID projectId) Sets the id of the project to publish.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsPublishOptions

public CmsPublishOptions()

Creates a new publish options bean.

CmsPublishOptions

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

Creates a new publish options bean.

Parameters:

includeRelated - Flag to include related resources

includeSiblings - Flag to include siblings

projectId - The id of the project to publish

Method Detail

getProjectId

public CmsUUID getProjectId()

Returns the project id.

Returns:

the project id

isIncludeRelated

public boolean isIncludeRelated()

Checks if to include related resources.

Returns:

true if to include related resources

isIncludeSiblings

public boolean isIncludeSiblings()

Checks if to include siblings.

Returns:

true if to include siblings

setIncludeRelated

public void setIncludeRelated(boolean includeRelated)

Sets the flag to include related resources.

Parameters:

includeRelated - the flag to set

setIncludeSiblings

public void setIncludeSiblings(boolean includeSiblings)

Sets the flag to include siblings.

Parameters:

includeSiblings - the flag to set

setProjectId

public void setProjectId(CmsUUID projectId)

Sets the id of the project to publish.

Parameters:

projectId - the id to set