com.hlcl.rql.as
Class TemplateVariant

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

All Implemented Interfaces:

CmsClientContainer, ProjectContainer, TemplateContainer, TemplateFolderContainer

public class TemplateVariant
extends java.lang.Object
implements TemplateContainer

Diese Klasse beschreibt eine Templatevariante, z.B. HTML, DEL_XML.

Author:

LEJAFR

Constructor Summary

TemplateVariant(Template template, java.lang.String templateVariantGuid, java.lang.String name)
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.
boolean	containsTemplateCode(java.lang.String elementName) Liefert true, falls dieser TemplateCode das gegebene Element elementName verwendet.
boolean	containsTemplateCodeRedDot(java.lang.String elementName) Liefert true, falls dieser TemplateCode für das gegebene Element elementName einen roten Punkt enthält.
boolean	equals(java.lang.Object obj) Zwei Variantenobjekte werden als identisch interpretiert, falls beide die gleiche GUID haben.
CmsClient	getCmsClient() Liefert den CmsClient.
java.lang.String	getFileExtension() Liefert die Dateierweiterung für publizierte Dateien.
java.lang.String	getLogonGuid() Liefert die RedDot logon GUID des users unter dem das script läuft.
java.lang.String	getName() Liefert den Namen dieses Exportpaketes.
Project	getProject() Liefert das Projekt.
java.lang.String	getProjectGuid() Liefert die RedDot GUID des Projekts.
java.lang.String	getSessionKey() Liefert den RedDot Session key.
Template	getTemplate() Liefert das Template zu dem dieses Element gehoert.
java.lang.String	getTemplateCode() Liefert den Template code für diese Templatevariante zurueck.
TemplateFolder	getTemplateFolder() Liefert den Template-Folder, in dem dieses Template enthalten ist.
java.lang.String	getTemplateFolderGuid() Liefert den Template-Folder GUID, in dem dieses Template enthalten ist.
java.lang.String	getTemplateGuid() Liefert die GUID des Templates vom Container.
java.lang.String	getTemplateVariantGuid() Liefert die GUID dieser Templatevariante.
int	hashCode() Wird auf die GUID zurückgeführt.
void	setFileExtension(java.lang.String extension) Ändert die Dateiendung dieser Templatevariante auf den gegebenen Wert.
boolean	usesTemplateCodeElement(java.lang.String elementName) Liefert true, falls dieser TemplateCode das gegebene Element elementName verwendet oder dafür einen roten Punkt enthält.
boolean	usesTemplateCodeElement(TemplateElement element) Liefert true, falls dieser TemplateCode das gegebene Element element verwendet oder dafür einen roten Punkt enthält.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateVariant

public TemplateVariant(Template template,
                       java.lang.String templateVariantGuid,
                       java.lang.String name)

constructor comment.

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

containsTemplateCode

public boolean containsTemplateCode(java.lang.String elementName)
                             throws RQLException

Liefert true, falls dieser TemplateCode das gegebene Element elementName verwendet.

Throws:

RQLException

containsTemplateCodeRedDot

public boolean containsTemplateCodeRedDot(java.lang.String elementName)
                                   throws RQLException

Liefert true, falls dieser TemplateCode für das gegebene Element elementName einen roten Punkt enthält.

Throws:

RQLException

equals

public boolean equals(java.lang.Object obj)

Zwei Variantenobjekte werden als identisch interpretiert, falls beide die gleiche GUID haben.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Boolean.hashCode(), Hashtable

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getFileExtension

public java.lang.String getFileExtension()
                                  throws RQLException

Liefert die Dateierweiterung für publizierte Dateien.

Throws:

RQLException

getLogonGuid

public java.lang.String getLogonGuid()

Liefert die RedDot logon GUID des users unter dem das script läuft. Dies ist nicht die des Users, falls er angemeldet ist!

Specified by:

getLogonGuid in interface CmsClientContainer

See Also:

getOwnLoginGuid

getName

public java.lang.String getName()

Liefert den Namen dieses Exportpaketes.

Returns:

java.lang.String

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

getTemplate

public Template getTemplate()

Liefert das Template zu dem dieses Element gehoert.

Specified by:

getTemplate in interface TemplateContainer

getTemplateCode

public java.lang.String getTemplateCode()
                                 throws RQLException

Liefert den Template code für diese Templatevariante zurueck.

Throws:

RQLException

See Also:

getDetailsNode()

getTemplateFolder

public TemplateFolder getTemplateFolder()

Liefert den Template-Folder, in dem dieses Template enthalten ist.

Specified by:

getTemplateFolder in interface TemplateFolderContainer

Returns:

TemplateFolder

getTemplateFolderGuid

public java.lang.String getTemplateFolderGuid()

Liefert den Template-Folder GUID, in dem dieses Template enthalten ist.

Specified by:

getTemplateFolderGuid in interface TemplateFolderContainer

Returns:

TemplateFolder

getTemplateGuid

public java.lang.String getTemplateGuid()

Liefert die GUID des Templates vom Container.

Specified by:

getTemplateGuid in interface TemplateContainer

getTemplateVariantGuid

public java.lang.String getTemplateVariantGuid()

Liefert die GUID dieser Templatevariante.

Returns:

java.lang.String

hashCode

public int hashCode()

Wird auf die GUID zurückgeführt.

Overrides:

hashCode in class java.lang.Object

setFileExtension

public void setFileExtension(java.lang.String extension)
                      throws RQLException

Ändert die Dateiendung dieser Templatevariante auf den gegebenen Wert.

Throws:

RQLException

usesTemplateCodeElement

public boolean usesTemplateCodeElement(java.lang.String elementName)
                                throws RQLException

Liefert true, falls dieser TemplateCode das gegebene Element elementName verwendet oder dafür einen roten Punkt enthält.

Throws:

RQLException

usesTemplateCodeElement

public boolean usesTemplateCodeElement(TemplateElement element)
                                throws RQLException

Liefert true, falls dieser TemplateCode das gegebene Element element verwendet oder dafür einen roten Punkt enthält.

Throws:

RQLException