com.hlcl.rql.util.as
Class ProjectPage

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

Direct Known Subclasses:

ChangeLogPage, ContentPage, PhysicalPage

public abstract class ProjectPage
extends java.lang.Object

Author:

lejafr This class is an abstract super class for all project related page, which wraps the general page and provide specialised interface. This project page acts as a normal page and is superclass for all content class implementations. An interface for the common page functions is needed to synchronize between Page and ProjectPage.

Constructor Summary

ProjectPage(Page page)
Constructor

Method Summary

void	assignAuthorizationPackage(AuthorizationPackage authorizationPackage, boolean inherit) Ordnet dieser Seite das gegebene Berechtigungspaket zu.
boolean	contains(java.lang.String templateElementName) Liefert true genau dann, wenn die Seite ein Element hat, das auf dem gegebenen TemplateElement basiert.
Page	createAndConnectPageAtContainer(java.lang.String containerTemplateElementName, Template template, boolean addAtBottom) Erzeugt eine neue Seite basierend auf template am Container mit dem gegebenen Namen in dieser Seite.
void	enterText(java.lang.String templateElementName, java.lang.String value) Erhält für HTML Elemente alle eingegebenen Zeichen (< wird zu <).
java.lang.String	getCreatedByUserName() Liefert den Namen des User, der diese Seite erstellt hat.
ReddotDate	getCreatedOn() Liefert den Zeitpunkt der Erstellung dieser Seite.
java.lang.String	getInfoText() Returns the page id, headline and content class name.
java.lang.String	getInfoText(java.lang.String separator) Returns the page id, headline and content class name getrennt von separator.
java.lang.String	getLastChangedByUserEmailAddress() Liefert die E-Mailadresse des User, der diese Seite zuletzt geändert hat.
java.lang.String	getLastChangedByUserName() Liefert den Namen des User, der diese Seite zuletzt geändert hat.
java.lang.String	getLastChangedOnAsddMMyyyyHmma() Liefert den Zeitpunkt der letzten Änderung dieser Seite im Format 26 Aug 2009 6:15 pm.
java.lang.String	getLockedByUserEmailAddress() Liefert die E-Mailadresse des Users, der die Seite sperrt oder zuletzt gesperrt hat.
java.lang.String	getLockedByUserName() Liefert den Usernamen des Autors, der die Seite sperrt oder zuletzt gesperrt hat.
java.lang.String	getLockedSinceAsddMMyyyyHmma() Liefert den Zeitpunkt seitdem diese Seite gesperrt ist im Format: 27 Aug 2008 1:41 PM.
java.lang.String	getOptionListValue(java.lang.String templateElementName) Liefert den Wert des OptionList Elements dieser Seite, das auf dem gegebenen templateElement basiert oder null,
Page	getPage() Returns the encapsulated page.
java.lang.String	getPageHeadline() Returns the page headline
java.lang.String	getPageHeadlineAndId() Returns the page headline and ID
java.lang.String	getPageId() Returns the page id.
java.lang.String	getPageInfoText() Returns the page info: headline, id and template name.
Project	getProject() Returns the project from the given page.
StandardFieldDateElement	getStandardFieldDateElement(java.lang.String templateElementName) Liefert Standardfeld Date Elements dieser Seite, das auf dem gegebenen templateElement basiert.
ReddotDate	getStandardFieldDateValue(java.lang.String templateElementName) Liefert den Wert des Standardfeld Date Elements dieser Seite, das auf dem gegebenen templateElement basiert.
StandardFieldNumericElement	getStandardFieldNumericElement(java.lang.String templateElementName) Liefert Standardfeld Textelements dieser Seite, das auf dem gegebenen templateElement basiert.
int	getStandardFieldNumericValue(java.lang.String templateElementName) Liefert den Wert des Standardfeld Numeric Elements dieser Seite, das auf dem gegebenen templateElement basiert.
StandardFieldTextElement	getStandardFieldTextElement(java.lang.String templateElementName) Liefert Standardfeld Textelements dieser Seite, das auf dem gegebenen templateElement basiert.
java.lang.String	getStandardFieldTextValue(java.lang.String templateElementName) Liefert den Wert des Standardfeld Textelements dieser Seite, das auf dem gegebenen templateElement basiert.
java.lang.String	getStateInfo() Liefert einen Text, der den Status dieser Seite beschreibt.
Template	getTemplateByGuid(java.lang.String templateGuid) Liefert das Template mit der gegebenen GUID vom Project.
TextElement	getTextElement(java.lang.String templateElementName) Liefert Textelement dieser Seite, das auf dem gegebenen templateElement basiert.
java.lang.String	getTextValue(java.lang.String templateElementName) Liefert den Wert des Textelements dieser Seite, das auf dem gegebenen templateElement basiert.
boolean	isChangeable() Liefert true, falls diese Seite durch den angegebenen User änderbar ist.
boolean	isInStateSavedAsDraft() Liefert true, falls diese Seite im Status draft ist (neu erstellt oder geändert).
boolean	isLocked() Liefert true, falls diese Seite gerade von einem anderen (als dem angemeldeten Benutzer) gesperrt ist.
boolean	isTextEmpty(java.lang.String templateElementName) Liefert true, falls das Textelements dieser Seite, das auf dem gegebenen templateElement basiert, leer ist.
void	setElementValues(java.util.Map elementValuePairs) Ändert alle Inhaltselemente dieser Seite mit nur einem RQL request.
void	setFilename(java.lang.String filename) Aendert den Dateinamen auf den gegebenen Wert.
void	setHeadline(java.lang.String headline) Aendert die Überschrift dieser Seite.
void	setOptionListValue(java.lang.String templateElementName, java.lang.String value) Aendert den Wert der Optionsliste dieser Seite, das auf dem gegebenen templateElement basiert.
void	setStandardFieldDateValue(java.lang.String templateElementName, ReddotDate value) Aendert den Wert des Standardfeld Date Elements dieser Seite, das auf dem gegebenen templateElement basiert.
void	setStandardFieldNumericValue(java.lang.String templateElementName, int value) Aendert den Wert des Standardfeld Numeric Elements dieser Seite, das auf dem gegebenen templateElement basiert.
void	setStandardFieldTextValue(java.lang.String templateElementName, java.lang.String value) Aendert den Wert des Standardfeld Textelements dieser Seite, das auf dem gegebenen templateElement basiert.
void	setTextValue(java.lang.String templateElementName, java.lang.String htmlSourceCode) Aendert den Wert des Textelements dieser Seite, das auf dem gegebenen templateElement basiert.
java.util.List	submitToWorkflow() Workflow: Übergibt eine Seite im Entwurf zur Prüfung an den Workflow.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectPage

public ProjectPage(Page page)

Constructor

Method Detail

assignAuthorizationPackage

public void assignAuthorizationPackage(AuthorizationPackage authorizationPackage,
                                       boolean inherit)
                                throws RQLException

Ordnet dieser Seite das gegebene Berechtigungspaket zu.

Throws:

RQLException

createAndConnectPageAtContainer

public Page createAndConnectPageAtContainer(java.lang.String containerTemplateElementName,
                                            Template template,
                                            boolean addAtBottom)
                                     throws RQLException

Erzeugt eine neue Seite basierend auf template am Container mit dem gegebenen Namen in dieser Seite. Die Seitenüberschrift der Containerseite wird aus der Überschrift dieser Seite und dem Templatenamen zusammengesetzt. Die Templatevorbelegung wird dabei nicht geprueft!

Parameters:

containerTemplateElementName - muss vom Typ 28 (Container) sein.

template - Typ der neu erstellten Seite.

addAtBottom - true=>seite wird nach unten verschoben, false=>seite wird nicht verschoben und RD default is oben anlegen

Throws:

RQLException

enterText

public void enterText(java.lang.String templateElementName,
                      java.lang.String value)
               throws RQLException

Erhält für HTML Elemente alle eingegebenen Zeichen (< wird zu <). Ein einzelnes blank (space) wird als Textwert geschrieben (zu ).

Throws:

RQLException

See Also:

setTextValue(String, String)

getInfoText

public java.lang.String getInfoText()
                             throws RQLException

Returns the page id, headline and content class name.

Throws:

RQLException

getInfoText

public java.lang.String getInfoText(java.lang.String separator)
                             throws RQLException

Returns the page id, headline and content class name getrennt von separator.

Throws:

RQLException

getLastChangedByUserEmailAddress

public java.lang.String getLastChangedByUserEmailAddress()
                                                  throws RQLException

Liefert die E-Mailadresse des User, der diese Seite zuletzt geändert hat.

Throws:

RQLException

getLastChangedByUserName

public java.lang.String getLastChangedByUserName()
                                          throws RQLException

Liefert den Namen des User, der diese Seite zuletzt geändert hat.

Throws:

RQLException

getLastChangedOnAsddMMyyyyHmma

public java.lang.String getLastChangedOnAsddMMyyyyHmma()
                                                throws RQLException

Liefert den Zeitpunkt der letzten Änderung dieser Seite im Format 26 Aug 2009 6:15 pm.

Throws:

RQLException

getLockedByUserEmailAddress

public java.lang.String getLockedByUserEmailAddress()
                                             throws RQLException

Liefert die E-Mailadresse des Users, der die Seite sperrt oder zuletzt gesperrt hat. Kann auch der angemeldete sein.

Throws:

RQLException

See Also:

isLocked()

getLockedByUserName

public java.lang.String getLockedByUserName()
                                     throws RQLException

Liefert den Usernamen des Autors, der die Seite sperrt oder zuletzt gesperrt hat. Kann auch der angemeldete sein.

Throws:

RQLException

See Also:

isLocked()

getLockedSinceAsddMMyyyyHmma

public java.lang.String getLockedSinceAsddMMyyyyHmma()
                                              throws RQLException

Liefert den Zeitpunkt seitdem diese Seite gesperrt ist im Format: 27 Aug 2008 1:41 PM.

Throws:

RQLException

See Also:

isLocked()

getPage

public Page getPage()

Returns the encapsulated page.

getPageHeadline

public java.lang.String getPageHeadline()
                                 throws RQLException

Returns the page headline

Throws:

RQLException

getPageHeadlineAndId

public java.lang.String getPageHeadlineAndId()
                                      throws RQLException

Returns the page headline and ID

Throws:

RQLException

getPageId

public java.lang.String getPageId()
                           throws RQLException

Returns the page id.

Throws:

RQLException

getPageInfoText

public java.lang.String getPageInfoText()
                                 throws RQLException

Returns the page info: headline, id and template name.

Throws:

RQLException

getProject

public Project getProject()

Returns the project from the given page.

getStandardFieldDateElement

public StandardFieldDateElement getStandardFieldDateElement(java.lang.String templateElementName)
                                                     throws RQLException

Liefert Standardfeld Date Elements dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 5 sein

Throws:

RQLException

getStandardFieldDateValue

public ReddotDate getStandardFieldDateValue(java.lang.String templateElementName)
                                     throws RQLException

Liefert den Wert des Standardfeld Date Elements dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 5 sein

Throws:

RQLException

getStandardFieldNumericElement

public StandardFieldNumericElement getStandardFieldNumericElement(java.lang.String templateElementName)
                                                           throws RQLException

Liefert Standardfeld Textelements dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 1 sein

Throws:

RQLException

getStandardFieldNumericValue

public int getStandardFieldNumericValue(java.lang.String templateElementName)
                                 throws RQLException

Liefert den Wert des Standardfeld Numeric Elements dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 48 sein

Throws:

RQLException

getStandardFieldTextElement

public StandardFieldTextElement getStandardFieldTextElement(java.lang.String templateElementName)
                                                     throws RQLException

Liefert Standardfeld Textelements dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 1 sein

Throws:

RQLException

getStandardFieldTextValue

public java.lang.String getStandardFieldTextValue(java.lang.String templateElementName)
                                           throws RQLException

Liefert den Wert des Standardfeld Textelements dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 1 sein

Throws:

RQLException

getTemplateByGuid

public Template getTemplateByGuid(java.lang.String templateGuid)
                           throws RQLException

Liefert das Template mit der gegebenen GUID vom Project.

Throws:

RQLException

getTextElement

public TextElement getTextElement(java.lang.String templateElementName)
                           throws RQLException

Liefert Textelement dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 32 sein

Throws:

RQLException

getOptionListValue

public java.lang.String getOptionListValue(java.lang.String templateElementName)
                                    throws RQLException

Liefert den Wert des OptionList Elements dieser Seite, das auf dem gegebenen templateElement basiert oder null,

falls weder diese Optionsliste einen Wert hat noch im Templateelement ein default gesetzt ist.

Throws:

RQLException

getTextValue

public java.lang.String getTextValue(java.lang.String templateElementName)
                              throws RQLException

Liefert den Wert des Textelements dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 32 sein

Throws:

RQLException

isChangeable

public boolean isChangeable()
                     throws RQLException

Liefert true, falls diese Seite durch den angegebenen User änderbar ist. Liefert true, falls diese Seite freigegeben ist. Liefert true, falls diese Seite im Draft oder auf Korrektur des angemeldeten Users steht.

Throws:

RQLException

isInStateSavedAsDraft

public boolean isInStateSavedAsDraft()
                              throws RQLException

Liefert true, falls diese Seite im Status draft ist (neu erstellt oder geändert). Dieser Test wirkt global. Er liefert immer true, falls die Seite im draft steht, egal ob beim angemeldeten Benutzer oder einem anderen.

Throws:

RQLException

See Also:

User.getPagesSavedAsDraft(Project)

isLocked

public boolean isLocked()
                 throws RQLException

Liefert true, falls diese Seite gerade von einem anderen (als dem angemeldeten Benutzer) gesperrt ist.

Nur falls true geliefert wird, liefern die folgenden Methoden von wem und seit wann die Sperre besteht.

Throws:

RQLException

isTextEmpty

public boolean isTextEmpty(java.lang.String templateElementName)
                    throws RQLException

Liefert true, falls das Textelements dieser Seite, das auf dem gegebenen templateElement basiert, leer ist.

Throws:

RQLException

setElementValues

public void setElementValues(java.util.Map elementValuePairs)
                      throws RQLException

Ändert alle Inhaltselemente dieser Seite mit nur einem RQL request.

Parameters:

elementValuePairs - Key=Element Objekt, Value=Objekt mit Wert mit passendem Typ

Throws:

RQLException

setFilename

public void setFilename(java.lang.String filename)
                 throws RQLException

Aendert den Dateinamen auf den gegebenen Wert.

Throws:

RQLException

setHeadline

public void setHeadline(java.lang.String headline)
                 throws RQLException

Aendert die Überschrift dieser Seite.

Throws:

RQLException

setStandardFieldDateValue

public void setStandardFieldDateValue(java.lang.String templateElementName,
                                      ReddotDate value)
                               throws RQLException

Aendert den Wert des Standardfeld Date Elements dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 5 sein

Throws:

RQLException

setStandardFieldNumericValue

public void setStandardFieldNumericValue(java.lang.String templateElementName,
                                         int value)
                                  throws RQLException

Aendert den Wert des Standardfeld Numeric Elements dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 48 sein

Throws:

RQLException

setStandardFieldTextValue

public void setStandardFieldTextValue(java.lang.String templateElementName,
                                      java.lang.String value)
                               throws RQLException

Aendert den Wert des Standardfeld Textelements dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 1 sein

Throws:

RQLException

setTextValue

public void setTextValue(java.lang.String templateElementName,
                         java.lang.String htmlSourceCode)
                  throws RQLException

Aendert den Wert des Textelements dieser Seite, das auf dem gegebenen templateElement basiert.

Parameters:

templateElementName - TemplateElement muss vom Typ 31 sein

htmlSourceCode - der HTML source code

Throws:

RQLException

submitToWorkflow

public java.util.List submitToWorkflow()
                                throws RQLException

Workflow: Übergibt eine Seite im Entwurf zur Prüfung an den Workflow. Vom aktuell angemeldeten User aus gesehen. Oder ohne Workflow, wird die Änderung des Autors an dieser Seite gespeichert, so dass sie für alle sichtbar ist.

Returns:

null, falls submit erfolgreich war java.util.List of TemplateElement, mit den fehlenden Pflichtfeldern

Throws:

RQLException

contains

public boolean contains(java.lang.String templateElementName)
                 throws RQLException

Liefert true genau dann, wenn die Seite ein Element hat, das auf dem gegebenen TemplateElement basiert.

Throws:

RQLException

getStateInfo

public java.lang.String getStateInfo()
                              throws RQLException

Liefert einen Text, der den Status dieser Seite beschreibt.

Throws:

RQLException

getCreatedByUserName

public java.lang.String getCreatedByUserName()
                                      throws RQLException

Liefert den Namen des User, der diese Seite erstellt hat. Liefert 'Unknown author', falls der User bereits gelöscht wurde.

Throws:

RQLException

See Also:

Page.hasCreatedUser()

getCreatedOn

public ReddotDate getCreatedOn()
                        throws RQLException

Liefert den Zeitpunkt der Erstellung dieser Seite.

Throws:

RQLException

setOptionListValue

public void setOptionListValue(java.lang.String templateElementName,
                               java.lang.String value)
                        throws RQLException

Aendert den Wert der Optionsliste dieser Seite, das auf dem gegebenen templateElement basiert. Der gegebenen Wert value wird dem Autor angezeigt. Es ist nicht die GUID der OptionListSelection.

Parameters:

templateElementName - TemplateElement muss Typ 8 sein

Throws:

RQLException