com.hlcl.rql.as
Class PublicationFolder

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

All Implemented Interfaces:

CmsClientContainer, ProjectContainer

public class PublicationFolder
extends java.lang.Object
implements ProjectContainer

Diese Klasse beschreibt ein Verzeichnis auf dem Ausgabeserver (Publication Folder der Publication Structure).

Author:

LEJAFR

Constructor Summary

PublicationFolder(Project project, java.lang.String name, java.lang.String publicationFolderGuid)
Folder 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.
PublicationFolder	createChildFolder(java.lang.String childName) Erstellt einen neuen Publication Folder unterhalb dieses Publication Folders.
boolean	equals(java.lang.Object obj) Zwei Folder werden als identisch interpretiert, falls beide die gleiche GUID haben.
PublicationFolder	getChildByName(java.lang.String childName) Liefert den child Publication Folder mit dem gegebenen Namen dieses Publication Folders, oder null, falls keiner mit dem Namen existiert.
CmsClient	getCmsClient() Liefert den CmsClient.
java.lang.String	getLogonGuid() Liefert die RedDot logon GUID.
java.lang.String	getName() Liefert den Namen dieses Folders.
Project	getProject() Liefert das Project, zu dem dieser Publication Folder gehoert.
java.lang.String	getProjectGuid() Liefert die RedDot GUID des Projekts.
java.lang.String	getPublicationFolderGuid() Liefert die RedDot GUID dieses Publicaton Folders.
java.lang.String	getPublishingPathFromPublishingRoot(java.lang.String pathSeparator) Liefert den Pfad zu diesem Folder (nur im 1.Level) unterhalb der root der Publishing Structure.
java.lang.String	getSessionKey() Liefert den RedDot Session key.
java.lang.String	toString() Show name for easier debugging.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PublicationFolder

public PublicationFolder(Project project,
                         java.lang.String name,
                         java.lang.String publicationFolderGuid)

Folder 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

equals

public boolean equals(java.lang.Object obj)

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

Overrides:

equals in class java.lang.Object

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getPublicationFolderGuid

public java.lang.String getPublicationFolderGuid()

Liefert die RedDot GUID dieses Publicaton Folders.

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 dieses Folders.

getPublishingPathFromPublishingRoot

public java.lang.String getPublishingPathFromPublishingRoot(java.lang.String pathSeparator)

Liefert den Pfad zu diesem Folder (nur im 1.Level) unterhalb der root der Publishing Structure. immer ohne / am Ende.

TODO der pfad muss rekursiv zusammengesetzt werden!

getProject

public Project getProject()

Liefert das Project, zu dem dieser Publication Folder gehoert.

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

getChildByName

public PublicationFolder getChildByName(java.lang.String childName)
                                 throws RQLException

Liefert den child Publication Folder mit dem gegebenen Namen dieses Publication Folders, oder null, falls keiner mit dem Namen existiert.

Benötigt den session key! Checks with equalsIgnoreCase().

Throws:

RQLException

createChildFolder

public PublicationFolder createChildFolder(java.lang.String childName)
                                    throws RQLException

Erstellt einen neuen Publication Folder unterhalb dieses Publication Folders. Der neu erstellte wird zurückgeliefert.

Throws:

RQLException

toString

public java.lang.String toString()

Show name for easier debugging.

Overrides:

toString in class java.lang.Object