org.opencms.ade.containerpage.shared
Class CmsCntPageData

java.lang.Object
  org.opencms.ade.containerpage.shared.CmsCntPageData

All Implemented Interfaces:

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

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

Convenience class to provide server-side information to the client.

Since:

8.0.0

Field Summary

static java.lang.String

DICT_NAME Name of the used dictionary.

Constructor Summary

protected	CmsCntPageData() Serialization constructor.
	CmsCntPageData(java.lang.String cntPageUri, java.lang.String noEditReason, java.lang.String requestParams, java.lang.String sitemapUri, java.lang.String sitePath, CmsUUID detailId, java.util.Map<java.lang.String,java.lang.String> newTypes, long lastModified, java.lang.String lockInfo, java.lang.String locale, boolean useClassicEditor, CmsTemplateContextInfo contextInfo) Constructor.

Method Summary

java.lang.String	getBacklinkUri() Returns the xml-content editor back-link URI.
java.lang.String	getContainerpageUri() Returns the container-page URI.
long	getDateLastModified() Gets the date at which the page was last modified.
CmsUUID	getDetailId() Returns the detail structure id, if available.
java.lang.String	getEditorUri() Returns the xml-content editor URI.
java.lang.String	getLocale() Returns the content locale.
java.lang.String	getLockInfo() Returns the lock information, if the page is locked by another user.
java.util.Map<java.lang.String,java.lang.String>	getNewTypes() Returns the map of available types and their new resource id's.
java.lang.String	getNoEditReason() Returns the no-edit reason.
java.lang.String	getRequestParams() Returns the request parameters.
java.lang.String	getSitemapUri() Returns the sitemap URI.
java.lang.String	getSitePath() Returns the sitemap path of the current container page, or null if the page is not reachable via the sitemap.
CmsTemplateContextInfo	getTemplateContextInfo() Gets the template context information.
boolean	isUseClassicEditor() Returns if the classic XmlContent editor should be used.

Methods inherited from class java.lang.Object

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

Field Detail

DICT_NAME

public static final java.lang.String DICT_NAME

Name of the used dictionary.

See Also:

Constant Field Values

Constructor Detail

CmsCntPageData

public CmsCntPageData(java.lang.String cntPageUri,
                      java.lang.String noEditReason,
                      java.lang.String requestParams,
                      java.lang.String sitemapUri,
                      java.lang.String sitePath,
                      CmsUUID detailId,
                      java.util.Map<java.lang.String,java.lang.String> newTypes,
                      long lastModified,
                      java.lang.String lockInfo,
                      java.lang.String locale,
                      boolean useClassicEditor,
                      CmsTemplateContextInfo contextInfo)

Constructor.

Parameters:

cntPageUri - the current container page URI

noEditReason - the reason why the current user is not allowed to edit the current container page

requestParams - the original request parameters

sitemapUri - the current sitemap URI

sitePath - a sitemap path (null if this container page isn't reachable through the sitemap)

detailId - the detail resource id, if available

newTypes - the map of available types and their new resource id's

lastModified - the last modification date of the page

lockInfo - lock information, if the page is locked by another user

locale - the content locale

useClassicEditor - true to use the classic XmlContent editor

contextInfo - the template context information

CmsCntPageData

protected CmsCntPageData()

Serialization constructor.

Method Detail

getBacklinkUri

public java.lang.String getBacklinkUri()

Returns the xml-content editor back-link URI.

Returns:

the back-link URI

getContainerpageUri

public java.lang.String getContainerpageUri()

Returns the container-page URI.

Returns:

the container-page URI

getDateLastModified

public long getDateLastModified()

Gets the date at which the page was last modified.

Returns:

the date at which the page was last modified

getDetailId

public CmsUUID getDetailId()

Returns the detail structure id, if available.

Returns:

the detail structure id

getEditorUri

public java.lang.String getEditorUri()

Returns the xml-content editor URI.

Returns:

the xml-content editor URI

getLocale

public java.lang.String getLocale()

Returns the content locale.

Returns:

the locale

getLockInfo

public java.lang.String getLockInfo()

Returns the lock information, if the page is locked by another user.

Returns:

the lock infomation

getNewTypes

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

Returns the map of available types and their new resource id's.

Returns:

the map of available types and their new resource id's

getNoEditReason

public java.lang.String getNoEditReason()

Returns the no-edit reason.

Returns:

the no-edit reason, if empty editing is allowed

getRequestParams

public java.lang.String getRequestParams()

Returns the request parameters.

Returns:

the request parameters

getSitemapUri

public java.lang.String getSitemapUri()

Returns the sitemap URI.

Returns:

the sitemap URI

getSitePath

public java.lang.String getSitePath()

Returns the sitemap path of the current container page, or null if the page is not reachable via the sitemap.

Returns:

the sitemap path

getTemplateContextInfo

public CmsTemplateContextInfo getTemplateContextInfo()

Gets the template context information.

Returns:

the template context information

isUseClassicEditor

public boolean isUseClassicEditor()

Returns if the classic XmlContent editor should be used.

Returns:

true if the classic XmlContent editor should be used