com.hlcl.rql.hip.as
Class PhysicalPage

java.lang.Object
  com.hlcl.rql.util.as.ProjectPage
      com.hlcl.rql.hip.as.PhysicalPage

public class PhysicalPage
extends ProjectPage

Author:

lejafr This class represents a physical page in the HIP project to deliver block childs and page childs.

Constructor Summary

PhysicalPage(Page page)
Construct a physical page wrapping the given general page.

Method Summary

java.util.Set	collectContainedText(java.lang.String findList, java.lang.String delimiter, boolean caseSensitive) Liefert alle in dieser physischen Seite gefundenen Begriffe.
PageArrayList	getAllNonPhysicalChildPages() Returns all child pages building this physical page (recursively down).
PageArrayList	getAllPhysicalChildPages(boolean collectNonPhysicalChildPagesAsWell) Returns all physical pages linked from this physical page.
java.lang.String	getPageGuid() Returns the GUID for the wrapped page.
java.lang.String[]	getVisibleHeadlineTemplateNameSuffixes() Returns the name suffixes for all templates having a visible reddot page headline.
boolean	hasVisibleHeadline() Returns true, if the reddot page headline of the wrapped page is visible.
boolean	hasVisibleHeadline(Page page) Returns true, if the reddot page headline of the given page is visible/searchable.
boolean	isPhysicalPage() Returns true, if the encapsulated page is a physical page in HIP.
PhysicalPage	morphInto(Page page) Returns a new physical page for the given page.

Methods inherited from class com.hlcl.rql.util.as.ProjectPage

assignAuthorizationPackage, contains, createAndConnectPageAtContainer, enterText, getCreatedByUserName, getCreatedOn, getInfoText, getInfoText, getLastChangedByUserEmailAddress, getLastChangedByUserName, getLastChangedOnAsddMMyyyyHmma, getLockedByUserEmailAddress, getLockedByUserName, getLockedSinceAsddMMyyyyHmma, getOptionListValue, getPage, getPageHeadline, getPageHeadlineAndId, getPageId, getPageInfoText, getProject, getStandardFieldDateElement, getStandardFieldDateValue, getStandardFieldNumericElement, getStandardFieldNumericValue, getStandardFieldTextElement, getStandardFieldTextValue, getStateInfo, getTemplateByGuid, getTextElement, getTextValue, isChangeable, isInStateSavedAsDraft, isLocked, isTextEmpty, setElementValues, setFilename, setHeadline, setOptionListValue, setStandardFieldDateValue, setStandardFieldNumericValue, setStandardFieldTextValue, setTextValue, submitToWorkflow

Methods inherited from class java.lang.Object

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

Constructor Detail

PhysicalPage

public PhysicalPage(Page page)
             throws RQLException

Construct a physical page wrapping the given general page.

Throws:

RQLException

Method Detail

collectContainedText

public java.util.Set collectContainedText(java.lang.String findList,
                                          java.lang.String delimiter,
                                          boolean caseSensitive)
                                   throws RQLException

Liefert alle in dieser physischen Seite gefundenen Begriffe.

Das zurückgegebene Set ist leer, wenn keiner der Begriffe auf dieser Seite und all ihren block childs vorkommt.

Throws:

RQLException

getAllNonPhysicalChildPages

public PageArrayList getAllNonPhysicalChildPages()
                                          throws RQLException

Returns all child pages building this physical page (recursively down). All block, row and section childs are gathered.

Throws:

RQLException

getAllPhysicalChildPages

public PageArrayList getAllPhysicalChildPages(boolean collectNonPhysicalChildPagesAsWell)
                                       throws RQLException

Returns all physical pages linked from this physical page.

Parameters:

collectNonPhysicalChildPagesAsWell - =true, collects all non physical pages as well =false, gets only physical pages - optimized

Throws:

RQLException

getPageGuid

public java.lang.String getPageGuid()
                             throws RQLException

Returns the GUID for the wrapped page.

Throws:

RQLException

isPhysicalPage

public boolean isPhysicalPage()
                       throws RQLException

Returns true, if the encapsulated page is a physical page in HIP.

Returns true, if the page has an element isPhysicalPage.

Throws:

RQLException

getVisibleHeadlineTemplateNameSuffixes

public java.lang.String[] getVisibleHeadlineTemplateNameSuffixes()
                                                          throws RQLException

Returns the name suffixes for all templates having a visible reddot page headline.

Throws:

RQLException

hasVisibleHeadline

public boolean hasVisibleHeadline()
                           throws RQLException

Returns true, if the reddot page headline of the wrapped page is visible.

Throws:

RQLException

hasVisibleHeadline

public boolean hasVisibleHeadline(Page page)
                           throws RQLException

Returns true, if the reddot page headline of the given page is visible/searchable.

Throws:

RQLException

morphInto

public PhysicalPage morphInto(Page page)
                       throws RQLException

Returns a new physical page for the given page. Reuse the parameters.

Throws:

RQLException