com.hlcl.rql.as
Class Element

java.lang.Object
  com.hlcl.rql.as.Element

All Implemented Interfaces:

CmsClientContainer, ContentElement, PageContainer, ProjectContainer

Direct Known Subclasses:

FileElement, OptionList, StandardFieldDateElement, StandardFieldNumericElement, StandardFieldTextElement, StandardFieldUserDefinedElement

public abstract class Element
extends java.lang.Object
implements PageContainer, ContentElement

Diese Klasse beschreibt ein RedDot Element einer Seite.

Author:

LEJAFR

Field Summary

protected java.lang.String

value

Constructor Summary

Element(Page page, TemplateElement templateElement, java.lang.String name, java.lang.String elementGuid, java.lang.String value)
Container constructor comment.

Method Summary

RQLNode	callCms(java.lang.String rqlRequest) Senden eine Anfrage an das CMS und liefert eine geparste Antwort zurueck.
java.lang.String	callCmsWithoutParsing(java.lang.String rqlRequest) Senden eine Anfrage an das CMS und liefert eine ungeparste Antwort zurueck.
void	deleteValue() Löscht den Wert dieses Elements.
CmsClient	getCmsClient() Liefert den CmsClient.
java.lang.String	getElementGuid() Liefert die RedDot GUID dieses Elements.
java.lang.String	getLogonGuid() Liefert die RedDot logon GUID.
java.lang.String	getName() Liefert den Namen des Elements auf der Seite.
Page	getPage() Liefert die Seite, die diesen MultiLink beinhaltet.
java.lang.String	getPageGuid() Liefert die RedDot GUID der Seite.
Project	getProject() Liefert das Projekt.
java.lang.String	getProjectGuid() Liefert die RedDot GUID des Projekts.
java.lang.String	getSessionKey() Liefert den RedDot Session key.
TemplateElement	getTemplateElement() Liefert das Template-Element auf dem dieses Seitenelement basiert.
java.lang.String	getTemplateElementName() Liefert den Namen des Template-Elemenst auf dem dieses Seitenelement basiert.
protected java.lang.String	getValue() Liefert den Wert des Elemens (auch den Dateinamen eines Bildes).
abstract java.lang.String	getValueAsString() Returns the content element's value converted into a string.
boolean	hasTemplateDefaultValue() Liefert true, falls für dieses Element ein Vorgabe im Template definiert ist.
boolean	isCombinedUpdateSupported() Liefert true, falls dieser Elementtyp die gemeinsame Änderung mit nur einem RQL unterstützt.
boolean	isEmpty() Liefert true, falls dieses Element keinen Wert anzeigt.
boolean	isValueEntered() Liefert true, falls in dieses Element eine Benutzereingabe erfolgt ist.
protected RQLNode	readElementNode() Liefert den RQLNode für dieses Elements mit dem eigenen RQL ELT action=load.
protected abstract void	setValue(java.lang.Object valueObj) Aendert polymorph den Wert dieses Elements.
protected void	setValue(java.lang.String value) Aendert den Wert des Elements (auch den Bildnamen).
java.lang.String	toString() Überschreibt den Standardwert für bequemes Debugging.

Methods inherited from class java.lang.Object

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

Field Detail

value

protected java.lang.String value

Constructor Detail

Element

public Element(Page page,
               TemplateElement templateElement,
               java.lang.String name,
               java.lang.String elementGuid,
               java.lang.String value)

Container constructor comment.

Parameters:

page - Seite, die diesen Container Link beinhaltet.

templateElement - TemplateElement auf dem dieses Element basiert

name - Name des Elements

elementGuid - GUID dieses Elements

value - Wert des Elements, auch Dateiname eines Bildes

Method Detail

callCms

public RQLNode callCms(java.lang.String rqlRequest)
                throws RQLException

Senden eine Anfrage an das CMS und liefert eine geparste Antwort zurueck.

Specified by:

callCms in interface CmsClientContainer

Throws:

RQLException

callCmsWithoutParsing

public java.lang.String callCmsWithoutParsing(java.lang.String rqlRequest)
                                       throws RQLException

Senden eine Anfrage an das CMS und liefert eine ungeparste Antwort zurueck. Erforderlich für die Ermittlung des Werts eines Textelements.

Specified by:

callCmsWithoutParsing in interface CmsClientContainer

Throws:

RQLException

getValueAsString

public abstract java.lang.String getValueAsString()
                                           throws RQLException

Returns the content element's value converted into a string. Browse implementors to find default conversion.

Specified by:

getValueAsString in interface ContentElement

Throws:

RQLException

deleteValue

public void deleteValue()
                 throws RQLException

Löscht den Wert dieses Elements. Funktioniert für alle StandardFelder (-text, -date, -numeric), Image- und Mediaelemente und OptionsListen.

Throws:

RQLException

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getElementGuid

public java.lang.String getElementGuid()

Liefert die RedDot GUID dieses Elements.

Returns:

java.lang.String

getLogonGuid

public java.lang.String getLogonGuid()

Liefert die RedDot logon GUID.

Specified by:

getLogonGuid in interface CmsClientContainer

getName

public java.lang.String getName()

Liefert den Namen des Elements auf der Seite.

Returns:

java.lang.String

getPage

public Page getPage()

Liefert die Seite, die diesen MultiLink beinhaltet.

Specified by:

getPage in interface PageContainer

getPageGuid

public java.lang.String getPageGuid()

Liefert die RedDot GUID der Seite.

Specified by:

getPageGuid in interface PageContainer

getProject

public Project getProject()

Liefert das Projekt.

Specified by:

getProject in interface ProjectContainer

getProjectGuid

public java.lang.String getProjectGuid()
                                throws RQLException

Liefert die RedDot GUID des Projekts.

Specified by:

getProjectGuid in interface ProjectContainer

Throws:

RQLException

getSessionKey

public java.lang.String getSessionKey()

Liefert den RedDot Session key.

Specified by:

getSessionKey in interface ProjectContainer

getTemplateElement

public TemplateElement getTemplateElement()

Liefert das Template-Element auf dem dieses Seitenelement basiert.

Specified by:

getTemplateElement in interface ContentElement

getTemplateElementName

public java.lang.String getTemplateElementName()

Liefert den Namen des Template-Elemenst auf dem dieses Seitenelement basiert.

Specified by:

getTemplateElementName in interface ContentElement

getValue

protected java.lang.String getValue()
                             throws RQLException

Liefert den Wert des Elemens (auch den Dateinamen eines Bildes). Liefert den Defaultwert aus dem Template, falls dort einer definiert ist. Liefert null, falls weder dieses Element einen Wert hat noch im Templateelement ein default gesetzt ist.

Returns:

java.lang.String

Throws:

RQLException

hasTemplateDefaultValue

public boolean hasTemplateDefaultValue()
                                throws RQLException

Liefert true, falls für dieses Element ein Vorgabe im Template definiert ist.

Throws:

RQLException

isCombinedUpdateSupported

public boolean isCombinedUpdateSupported()
                                  throws RQLException

Liefert true, falls dieser Elementtyp die gemeinsame Änderung mit nur einem RQL unterstützt.

Throws:

RQLException

See Also:

Page.setElementValues(Map)

isEmpty

public boolean isEmpty()
                throws RQLException

Liefert true, falls dieses Element keinen Wert anzeigt.

Der Vorgabewert aus dem Template wird mit einbezogen.

Throws:

RQLException

isValueEntered

public boolean isValueEntered()
                       throws RQLException

Liefert true, falls in dieses Element eine Benutzereingabe erfolgt ist.

Throws:

RQLException

setValue

protected abstract void setValue(java.lang.Object valueObj)
                          throws RQLException

Aendert polymorph den Wert dieses Elements. Der Typ von valuObj muss zum Typ des Elementes passen.

Parameters:

valueObj - valueObj muss ein Object passend zum Typ dieses Elementes sein

Throws:

RQLException

setValue

protected void setValue(java.lang.String value)
                 throws RQLException

Aendert den Wert des Elements (auch den Bildnamen).

Throws:

RQLException

readElementNode

protected RQLNode readElementNode()
                           throws RQLException

Liefert den RQLNode für dieses Elements mit dem eigenen RQL ELT action=load.

Throws:

RQLException

toString

public java.lang.String toString()

Überschreibt den Standardwert für bequemes Debugging.

Overrides:

toString in class java.lang.Object