com.hlcl.rql.as
Class TemplateFolder

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

All Implemented Interfaces:

CmsClientContainer, ProjectContainer

public class TemplateFolder
extends java.lang.Object
implements ProjectContainer

Diese Klasse beschreibt einen RedDot Template Folder.

Author:

LEJAFR

Constructor Summary

TemplateFolder(Project project, java.lang.String name, java.lang.String templateFolderGuid)
Erzeugt einen neuen TemplateFolder für das gegebenen Projekt.

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	contains(Template template) Liefert true, wenn das gegebene Template in diesem Folder existiert, sonst false.
boolean	containsByName(java.lang.String templateName) Liefert true, wenn es in diesem Ordner ein Template mit dem gegebenen Namen gibt, sonst false.
CmsClient	getCmsClient() Liefert den CmsClient.
java.lang.String	getLogonGuid() Liefert die Logon GUID vom Container.
java.lang.String	getName() Liefert den Namen des Template folders.
Project	getProject() Liefert das Project, den Container des Folders.
java.lang.String	getProjectGuid() Liefert die RedDot GUID des Projekts.
java.lang.String	getSessionKey() Liefert den RedDot Session key.
Template	getTemplateByName(java.lang.String name) Liefert das Template mit dem gegebenen Namen vom CMS zurück.
java.lang.String	getTemplateFolderGuid() Liefert die GUID dieses TemplateFolders.
java.util.Set<java.lang.String>	getTemplateNames() Liefert ein Set mit allen Templatenamen dieses Ordners.
java.util.List<Template>	getTemplates() Liefert eine Liste mit allen Templates dieses Ordners.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateFolder

public TemplateFolder(Project project,
                      java.lang.String name,
                      java.lang.String templateFolderGuid)

Erzeugt einen neuen TemplateFolder für das gegebenen Projekt.

Parameters:

project - Projekt, zu dem dieser TemplateFolder gehört

name - Name dieses TemplateFolders

templateFolderGuid - RedDot GUID dieses Verzeichnises

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

contains

public boolean contains(Template template)
                 throws RQLException

Liefert true, wenn das gegebene Template in diesem Folder existiert, sonst false. Berücksichtigt Berechtigungen an Templates.

Throws:

RQLException

containsByName

public boolean containsByName(java.lang.String templateName)
                       throws RQLException

Liefert true, wenn es in diesem Ordner ein Template mit dem gegebenen Namen gibt, sonst false.

Berücksichtigt Berechtigungen an Templates: Ist ein Template für den connected user nicht zugelassen, wird false geliefert auch wenn es in diesem folder enthalten ist.

Throws:

RQLException

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getLogonGuid

public java.lang.String getLogonGuid()

Liefert die Logon GUID vom Container.

Specified by:

getLogonGuid in interface CmsClientContainer

See Also:

Project

getName

public java.lang.String getName()

Liefert den Namen des Template folders.

Returns:

String

getProject

public Project getProject()

Liefert das Project, den Container des Folders.

Specified by:

getProject in interface ProjectContainer

See Also:

Project

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

getTemplateByName

public Template getTemplateByName(java.lang.String name)
                           throws RQLException

Liefert das Template mit dem gegebenen Namen vom CMS zurück.

Parameters:

name - Name des Templates.

Returns:

Template

Throws:

RQLException

See Also:

Template

getTemplateFolderGuid

public java.lang.String getTemplateFolderGuid()

Liefert die GUID dieses TemplateFolders.

Returns:

String

getTemplateNames

public java.util.Set<java.lang.String> getTemplateNames()
                                                 throws RQLException

Liefert ein Set mit allen Templatenamen dieses Ordners. Berücksichtigt Berechtigungen an Templates.

Throws:

RQLException

getTemplates

public java.util.List<Template> getTemplates()
                                      throws RQLException

Liefert eine Liste mit allen Templates dieses Ordners. Berücksichtigt Berechtigungen an Templates.

Throws:

RQLException