nl.gx.webmanager.cms.core
Interface PageVersion

All Superinterfaces:

ElementHolder, Presentable, WorkflowEnabled, Wrapper

public interface PageVersion
extends ElementHolder, WorkflowEnabled

Representation of version of a page. A page always has at least one version (the current version) and 0 or more other versions. These 'other' versions may be older public versions, newer non public versions or versions with a different language.

Method Summary

int	copyLanguageVersion(java.lang.String webid, java.lang.String languageid, java.lang.String l_id) Creates a copy of the section for a particular language and returns its id.
java.lang.String	getAlternativeURLPath() Returns the alternative URL path.
int	getBlockConfigId() Return id of the page's block config.
Page[]	getBlocks()
Page[]	getBlocks(BlockLabel[] labels) Return Page objects for a array of BlockLabels.
java.util.Date	getCreationDate() Return creation date of the page version.
java.lang.String	getExcludeScriptsTag() Return exclude scripts tag for use in frames.
java.util.Date	getExpirationDate() Return expiration date of the page version.
int	getExpire() Return page expire.
java.lang.String	getFriendlyURLTitle() Return friendly URL title.
boolean	getHasLead() Return if this page has a lead
boolean	getHasRedirect() Return if this page has a redirect
java.lang.String	getHtmlTitle() Return the HTML title.
boolean	getIncludeInSearchEngine() Returns if this page version is included to be found by a search engine
java.lang.String	getInlineModeTag() Return inline mode tag.
java.lang.String[]	getLabels() Return page labels.
Language	getLanguage() Return language of this page.
java.util.Date	getLastModifiedDate() Return last modified date of the page version.
User	getLastModifiedUser() Return the last modified user of this page version.
java.lang.String	getLastModifiedUsername() Return last modified username of the page version.
java.lang.String	getLead() Return lead text.
MetaTag[]	getMetaTags() Return array of MetaTag.
java.lang.String	getNavigationTitle() Return navigation title.
java.lang.String	getNoReadAccessText() Returns text for a user indicating he has no read access for this PageVersion object.
Page	getPage() Returns Page object of which this object is a version.
PageLabel[]	getPageLabels() Return page labels.
PageMetaData[]	getPageMetaData() Returns the meta data objects assigned to this PageVersion.
java.util.Map<java.lang.String,PageMetaData>	getPageMetaDataFBOMap() Constructs and returns an FBO map for page meta data.
Personalization	getPersonalization() Return personalization object for this page.
java.lang.String	getPreviewForms(boolean containsContentElements) Return the forms necessary for WebManager to function properly in the preview mode.
java.lang.String	getPreviewJavascript(boolean containsContentElements) Used to generate javascript for previewing this page (WebManager needs this to function properly).
java.lang.String	getPreviewTopBody(boolean containsContentElements) Return the top of the body necessary for WebManager to function properly in the layout mode.
java.util.Date	getPublicationDate() Return publication date of the page version.
Redirect	getRedirect() Return Redirect.
RelatedLink[]	getRelatedLinks() Return related links for this PageVersion.
java.lang.String	getRemark() Return remark text.
ResourceEntity	getResourceEntity() Return database page or null if it is not a database page.
ResourceInstance	getResourceInstance() Return database id (if this is a database id) or 0.
java.lang.String	getSeeEvent() Deprecated.
StyleSheet[]	getStyleSheets() Return stylesheets for this page.
Page[]	getSubPages() Returns the sub pages of this version.
Page[]	getSubPagesWithCurrent() Return array of subpages, which have a current version.
java.lang.String	getTitle() Return page title.
java.lang.String	getUrlTitle() Return page url title; this is used to override the default friendly URL for this pageversion.
java.lang.String	getXslFoUrl() Return url to the page xsl.
java.lang.String	getXslUrl() Return url to the page xsl.
boolean	isAuthorized(java.lang.String permission) Return true if the user is authorized to preview this page.
boolean	isAuthorizedToPreview() Returns true if the current user is authorizaed to preview this PageVersion object.
boolean	isPublic() Return true if the page has a public state.
boolean	isSecure() Return true if the page is accessed over a secure connection.
void	processHttpServletRequest(java.util.List<nl.gx.webmanager.foundation.NameValuePair> dynamicAttributes) Processes the HttpServletRequest of the page submission for this PageVersion.
void	setExpirationDate(java.util.Date value) Set the expiration date of the page version.
void	setHtmlTitle(java.lang.String value) Set page html title.
void	setIncludeInSearchEngine(boolean value) Sets if this page version is included to be found by a search engine
void	setLead(java.lang.String value) Set lead text
void	setNavigationTitle(java.lang.String value) Set page navigation title.
void	setPublicationDate(java.util.Date value) Set the publication date of the page version.
void	setRemark(java.lang.String value) Set remark text
void	setTitle(java.lang.String value) Set page title.
void	setUrlTitle(java.lang.String value) Set page url title to override the default friendly URL for this pageversion.
void	synchronizeMediaItemPageVersion() Checks if a media item page version is connected to the page version and if so it synchronizes it with the page version.
void	synchronizePageMetaData() Make sure each page has exactly one object for each available page meta data component.

Methods inherited from interface nl.gx.webmanager.cms.core.ElementHolder

addRelatedLink, createRichTextElements, getElementHolderElements, getElements, getElementsFBOMap, getFBOMap, getLastElement, getModelElements, getModelElementsFBOMap, getRelatedLink, getWebsite, insertLastElementAtCursor, isAdditionalElementsAllowed, setElementHolderElements, setModelElements

Methods inherited from interface nl.gx.webmanager.cms.core.Presentable

getPresentation, render, render, setPresentation

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Methods inherited from interface nl.gx.webmanager.cms.workflow.WorkflowEnabled

getWorkflowModel, getWorkflowModelInstance

Method Detail

getTitle

java.lang.String getTitle()

Return page title.

Returns:

page title.

setTitle

void setTitle(java.lang.String value)

Set page title.

Parameters:

value - the page title

getNavigationTitle

java.lang.String getNavigationTitle()

Return navigation title.

Returns:

navigation title.

setNavigationTitle

void setNavigationTitle(java.lang.String value)

Set page navigation title.

Parameters:

value - the page navigation title

getHtmlTitle

java.lang.String getHtmlTitle()

Return the HTML title. This is a title string which is suitable for use in the HTML TITLE tag. If no HTML title has been explicietly specified for the page then an empty string is returned.

Returns:

HTML title, or "" if none has been specified.

getFriendlyURLTitle

java.lang.String getFriendlyURLTitle()

Return friendly URL title.

Returns:

friendly URL title.

getAlternativeURLPath

java.lang.String getAlternativeURLPath()

Returns the alternative URL path. Links only uses this alternative URL path if friendly URL functionality is turned on.

Returns:

alternative URL path.

setHtmlTitle

void setHtmlTitle(java.lang.String value)

Set page html title.

Parameters:

value - the page html title

setUrlTitle

void setUrlTitle(java.lang.String value)

Set page url title to override the default friendly URL for this pageversion.

Parameters:

value - the page url title

getUrlTitle

java.lang.String getUrlTitle()

Return page url title; this is used to override the default friendly URL for this pageversion.

Returns:

value the page url title

getIncludeInSearchEngine

boolean getIncludeInSearchEngine()

Returns if this page version is included to be found by a search engine

Returns:

is included in search engine

setIncludeInSearchEngine

void setIncludeInSearchEngine(boolean value)

Sets if this page version is included to be found by a search engine

Parameters:

value - set included in search engine

getResourceInstance

ResourceInstance getResourceInstance()

Return database id (if this is a database id) or 0.

Returns:

database id (if this is a database id) or 0.

getResourceEntity

ResourceEntity getResourceEntity()

Return database page or null if it is not a database page.

Returns:

database page or null if it is not a database page.

getPage

Page getPage()

Returns Page object of which this object is a version.

Returns:

Page object of which this object is a version.

getSubPages

Page[] getSubPages()

Returns the sub pages of this version. The order in which these sub pages are returned reflects the order configured in WebManager. Only these sub pages are returned which are not marked invisible for navigation in WebManager.

Returns:

sub pages.

See Also:

getSubPagesWithCurrent(), Page.getSubPages()

getSubPagesWithCurrent

Page[] getSubPagesWithCurrent()

Return array of subpages, which have a current version.

Returns:

array of subpages, which have a current version.

See Also:

getSubPages(), Page.getSubPages()

getLanguage

Language getLanguage()

Return language of this page.

Returns:

language of this page.

getMetaTags

MetaTag[] getMetaTags()

Return array of MetaTag.

Returns:

array of MetaTag.

getPreviewJavascript

java.lang.String getPreviewJavascript(boolean containsContentElements)

Used to generate javascript for previewing this page (WebManager needs this to function properly).

Parameters:

containsContentElements - if true, the page/frame contains the WebManager content.

Returns:

javascript

getPreviewForms

java.lang.String getPreviewForms(boolean containsContentElements)

Return the forms necessary for WebManager to function properly in the preview mode.

Parameters:

containsContentElements - if true, the page/frame contains the WebManager content.

Returns:

the forms necessary for WebManager to function properly in the preview mode.

getPreviewTopBody

java.lang.String getPreviewTopBody(boolean containsContentElements)

Return the top of the body necessary for WebManager to function properly in the layout mode.

Parameters:

containsContentElements - if true, the page/frame contains the WebManager content.

Returns:

the top of the body necessary for WebManager to function properly in the layout mode.

isAuthorized

boolean isAuthorized(java.lang.String permission)

Return true if the user is authorized to preview this page.

Returns:

true if the user is authorized for this page.

isAuthorizedToPreview

boolean isAuthorizedToPreview()

Returns true if the current user is authorizaed to preview this PageVersion object.

Returns:

true if the current user is authorizaed to preview this PageVersion object

getLead

java.lang.String getLead()

Return lead text.

Returns:

lead text.

setLead

void setLead(java.lang.String value)

Set lead text

Parameters:

value - the lead text

getHasLead

boolean getHasLead()

Return if this page has a lead

Returns:

true if the page has a lead, false otherwise

getRemark

java.lang.String getRemark()

Return remark text.

Returns:

remark text.

setRemark

void setRemark(java.lang.String value)

Set remark text

Parameters:

value - the remark text

getHasRedirect

boolean getHasRedirect()

Return if this page has a redirect

Returns:

true if the page has a redirect, false otherwise

getSeeEvent

@Deprecated
java.lang.String getSeeEvent()

Deprecated.

Return see event.

Returns:

see event.

getRedirect

Redirect getRedirect()

Return Redirect.

Returns:

Redirect or null.

getInlineModeTag

java.lang.String getInlineModeTag()

Return inline mode tag.

Returns:

constant inline mode tag: "<!-- Content -->".

getExcludeScriptsTag

java.lang.String getExcludeScriptsTag()

Return exclude scripts tag for use in frames.

Returns:

constant exclude script tag: "<!-- ExcludeScripts -->".

getBlocks

Page[] getBlocks(BlockLabel[] labels)

Return Page objects for a array of BlockLabels.

Parameters:

labels - block labels

Returns:

Page objects

getBlocks

Page[] getBlocks()

Returns:

all blocks on the page.

getPersonalization

Personalization getPersonalization()

Return personalization object for this page.

Returns:

personalization object for this page.

getStyleSheets

StyleSheet[] getStyleSheets()

Return stylesheets for this page.

Returns:

stylesheets for this page.

getPublicationDate

java.util.Date getPublicationDate()

Return publication date of the page version.

Returns:

publication date of the page version.

setPublicationDate

void setPublicationDate(java.util.Date value)

Set the publication date of the page version.

Parameters:

value - publication date of the page version.

getExpirationDate

java.util.Date getExpirationDate()

Return expiration date of the page version.

Returns:

expiration date of the page version.

setExpirationDate

void setExpirationDate(java.util.Date value)

Set the expiration date of the page version.

Parameters:

value - expiration date of the page version.

getCreationDate

java.util.Date getCreationDate()

Return creation date of the page version.

Returns:

creation date of the page version.

getLastModifiedDate

java.util.Date getLastModifiedDate()

Return last modified date of the page version.

Returns:

last modified date of the page version.

getLastModifiedUsername

java.lang.String getLastModifiedUsername()

Return last modified username of the page version.

Returns:

last modified username of the page version.

getLastModifiedUser

User getLastModifiedUser()

Return the last modified user of this page version.

Returns:

The user object who modified this page last.

isSecure

boolean isSecure()

Return true if the page is accessed over a secure connection.

Returns:

true if the page is accessed over a secure connection.

isPublic

boolean isPublic()

Return true if the page has a public state.

Returns:

true if the page has a public state.

getXslUrl

java.lang.String getXslUrl()

Return url to the page xsl.

Returns:

url to the page xsl.

getXslFoUrl

java.lang.String getXslFoUrl()

Return url to the page xsl.

Returns:

url to the page xsl.

getLabels

java.lang.String[] getLabels()

Return page labels.

Returns:

page labels.

getPageLabels

PageLabel[] getPageLabels()

Return page labels.

Returns:

page labels.

getExpire

int getExpire()

Return page expire.

Returns:

page expire.

getBlockConfigId

int getBlockConfigId()

Return id of the page's block config.

Returns:

id of the page's block config.

getRelatedLinks

RelatedLink[] getRelatedLinks()

Return related links for this PageVersion.

Specified by:

getRelatedLinks in interface ElementHolder

Returns:

related links for this PageVersion.

synchronizeMediaItemPageVersion

void synchronizeMediaItemPageVersion()

Checks if a media item page version is connected to the page version and if so it synchronizes it with the page version.

copyLanguageVersion

int copyLanguageVersion(java.lang.String webid,
                        java.lang.String languageid,
                        java.lang.String l_id)

Creates a copy of the section for a particular language and returns its id.

Parameters:

webid - Id of the webinitiatif

languageid - Id of the language to copy the version to

processHttpServletRequest

void processHttpServletRequest(java.util.List<nl.gx.webmanager.foundation.NameValuePair> dynamicAttributes)

Processes the HttpServletRequest of the page submission for this PageVersion.

Parameters:

dynamicAttributes - List of NameValuePair objects based on the qs parameter

getNoReadAccessText

java.lang.String getNoReadAccessText()

Returns text for a user indicating he has no read access for this PageVersion object.

Returns:

text for a user indicating he has no read access for this PageVersion object

getPageMetaData

PageMetaData[] getPageMetaData()

Returns the meta data objects assigned to this PageVersion.

Returns:

the meta data objects assigned to this PageVersion

synchronizePageMetaData

void synchronizePageMetaData()

Make sure each page has exactly one object for each available page meta data component.

getPageMetaDataFBOMap

java.util.Map<java.lang.String,PageMetaData> getPageMetaDataFBOMap()

Constructs and returns an FBO map for page meta data.

Returns:

map of PageMetaData form backing objects, cataloged by their UUID.