com.hlcl.rql.as
Class Folder

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

All Implemented Interfaces:

CmsClientContainer, ProjectContainer

Direct Known Subclasses:

AssetManagerFolder, AssetManagerSubFolder, FileFolder

public abstract class Folder
extends java.lang.Object
implements ProjectContainer

Diese Klasse beschreibt ein Datei Verzeichnis aus RedDot.

Author:

LEJAFR

Constructor Summary

Folder(Project project, java.lang.String name, java.lang.String folderGuid, java.lang.String hideInTextEditor, java.lang.String saveType, java.lang.String path)
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.
boolean	equals(java.lang.Object obj) Zwei Folder werden als identisch interpretiert, falls beide die gleiche GUID haben.
boolean	exists(java.lang.String filename) Liefert genau dann true, wenn der gegebene Dateiname in diesem Folder existiert.
boolean	existsInSubFolder(java.lang.String filename) Liefert für normale folder und subfolder immer true, damit die exists() prüfung für diese ordner positiv ausfällt.
CmsClient	getCmsClient() Liefert den CmsClient.
java.lang.String	getFileSystemPath() Liefert den Pfad dieses Folder im Dateisystem, falls die Inhalte im Dateisystem abgelegt werden.
java.lang.String	getFolderGuid() Liefert die RedDot GUID dieses Folders.
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 Folder gehoert.
java.lang.String	getProjectGuid() Liefert die RedDot GUID des Projekts.
java.lang.String	getSessionKey() Liefert den RedDot Session key.
boolean	hasNoSubFolders() Liefert per default immer true.
boolean	hasSubFolders() Liefert immer per default immer false.
boolean	isAssetManagerFolder() Liefert true, falls dieser folder ein AssetManager ist.
boolean	isAssetManagerSubFolder() Liefert true, falls dieser folder ein Unterordner eines AssetManagers ist.
boolean	isAvailableInTextEditor() Liefert true, falls dieser FileFolder oder AssetManager im TextEditor nutzbar ist, sonst false;
boolean	isFileFolder() Liefert true, falls dieser folder ein einfacher FileFolder ist.
boolean	isStoredInExternalSystem() Liefert true, falls die Inhalte dieses FileFolders oder AssetManagers außerhalb RedDots gespeichert werden, z.B.
boolean	isStoredInFileSystem() Liefert true, falls die Inhalte dieses FileFolders oder AssetManagers im Dateisystem gespeichert werden.
boolean	isStoredInOtherProject() Liefert true, falls die Inhalte dieses FileFolders oder AssetManagers innerhalb eines anderen RedDot Projektes gespeichert werden.
boolean	isStoredInternal() Liefert true, falls die Inhalte dieses FileFolders oder AssetManagers innerhalb der RedDot Projektdatenbank gespeichert werden.
java.lang.String	replaceFileSystemPath(java.lang.String find, java.lang.String replace) Ersetzt im Pfad dieses Folders im Dateisystem den gegebenen String find mit replace, falls find gefunden wurde.
java.util.List<File>	searchFiles(java.lang.String pattern) Liefert alle Files dieses Ordners, die dem pattern genügen.
java.util.List<File>	searchFiles(java.lang.String pattern, java.lang.String suffixes) Liefert alle Files dieses Ordners, die dem pattern genügen und deren Extender in der Liste der suffixes ist.
java.util.List<File>	searchFiles(java.lang.String pattern, java.lang.String suffixes, java.lang.String exceptionSuffix) Liefert alle Files dieses Ordners, die dem pattern genügen und deren Extender in der Liste der suffixes ist.
java.util.List<File>	searchFiles(java.lang.String pattern, TemplateElement templateElement) Liefert alle Files dieses Ordners, die dem pattern genügen.
java.util.List<File>	searchFiles(java.lang.String pattern, TemplateElement templateElement, java.lang.String exceptionSuffix) Liefert alle Files dieses Ordners, die dem pattern genügen.

Methods inherited from class java.lang.Object

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

Constructor Detail

Folder

public Folder(Project project,
              java.lang.String name,
              java.lang.String folderGuid,
              java.lang.String hideInTextEditor,
              java.lang.String saveType,
              java.lang.String path)

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

exists

public boolean exists(java.lang.String filename)
               throws RQLException

Liefert genau dann true, wenn der gegebene Dateiname in diesem Folder existiert.

Throws:

RQLException

existsInSubFolder

public boolean existsInSubFolder(java.lang.String filename)
                          throws RQLException

Liefert für normale folder und subfolder immer true, damit die exists() prüfung für diese ordner positiv ausfällt.

Throws:

RQLException

See Also:

AssetManagerFolder.existsInSubFolder(String), exists(String), exists(String)

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getFileSystemPath

public java.lang.String getFileSystemPath()
                                   throws RQLException

Liefert den Pfad dieses Folder im Dateisystem, falls die Inhalte im Dateisystem abgelegt werden.

Throws:

WrongStorageTypeException - falls die Inhalte dieses Folders nicht im Dateisystem abgelegt werden

RQLException

replaceFileSystemPath

public java.lang.String replaceFileSystemPath(java.lang.String find,
                                              java.lang.String replace)
                                       throws RQLException

Ersetzt im Pfad dieses Folders im Dateisystem den gegebenen String find mit replace, falls find gefunden wurde.

Achtung: Es wird keine Prüfung vorgenommen, ob der neue Pfad auch im Dateisystem vorhanden ist!

Returns:

replaced path

Throws:

WrongStorageTypeException - falls die Inhalte dieses Folders nicht im Dateisystem abgelegt werden

RQLException

getFolderGuid

public java.lang.String getFolderGuid()

Liefert die RedDot GUID dieses 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.

getProject

public Project getProject()

Liefert das Project, zu dem dieser 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

hasNoSubFolders

public boolean hasNoSubFolders()
                        throws RQLException

Liefert per default immer true. Wird in Unterklasse asset manager überschrieben.

Throws:

RQLException

See Also:

AssetManagerFolder.hasNoSubFolders()

hasSubFolders

public boolean hasSubFolders()
                      throws RQLException

Liefert immer per default immer false. Wird in Unterklasse asset manager überschrieben.

Throws:

RQLException

See Also:

AssetManagerFolder.hasSubFolders()

isAssetManagerFolder

public boolean isAssetManagerFolder()

Liefert true, falls dieser folder ein AssetManager ist. Wird von der Subklasse mit true überschrieben.

isAssetManagerSubFolder

public boolean isAssetManagerSubFolder()

Liefert true, falls dieser folder ein Unterordner eines AssetManagers ist. Wird von der Subklasse mit true überschrieben.

isAvailableInTextEditor

public boolean isAvailableInTextEditor()
                                throws RQLException

Liefert true, falls dieser FileFolder oder AssetManager im TextEditor nutzbar ist, sonst false;

Throws:

RQLException

isFileFolder

public boolean isFileFolder()

Liefert true, falls dieser folder ein einfacher FileFolder ist. Wird von der Subklasse mit true überschrieben.

isStoredInExternalSystem

public boolean isStoredInExternalSystem()
                                 throws RQLException

Liefert true, falls die Inhalte dieses FileFolders oder AssetManagers außerhalb RedDots gespeichert werden, z.B. in einem Dokumentenmanagementsystems (DMS).

Throws:

RQLException

isStoredInFileSystem

public boolean isStoredInFileSystem()
                             throws RQLException

Liefert true, falls die Inhalte dieses FileFolders oder AssetManagers im Dateisystem gespeichert werden.

Throws:

RQLException

isStoredInOtherProject

public boolean isStoredInOtherProject()
                               throws RQLException

Liefert true, falls die Inhalte dieses FileFolders oder AssetManagers innerhalb eines anderen RedDot Projektes gespeichert werden.

Throws:

RQLException

isStoredInternal

public boolean isStoredInternal()
                         throws RQLException

Liefert true, falls die Inhalte dieses FileFolders oder AssetManagers innerhalb der RedDot Projektdatenbank gespeichert werden.

Throws:

RQLException

searchFiles

public java.util.List<File> searchFiles(java.lang.String pattern)
                                 throws RQLException

Liefert alle Files dieses Ordners, die dem pattern genügen. Achtung diese Liste kann sehr groß werden.

Parameters:

pattern - Teil des Names incl. Wildcards (*)

Throws:

RQLException

searchFiles

public java.util.List<File> searchFiles(java.lang.String pattern,
                                        java.lang.String suffixes)
                                 throws RQLException

Liefert alle Files dieses Ordners, die dem pattern genügen und deren Extender in der Liste der suffixes ist.

Parameters:

pattern - Teil des Names incl. Wildcards (*)

suffixes - zugelassene Extender aus dem FileElement

Throws:

RQLException

searchFiles

public java.util.List<File> searchFiles(java.lang.String pattern,
                                        java.lang.String suffixes,
                                        java.lang.String exceptionSuffix)
                                 throws RQLException

Liefert alle Files dieses Ordners, die dem pattern genügen und deren Extender in der Liste der suffixes ist.

Parameters:

pattern - Teil des Names incl. Wildcards (*)

suffixes - zugelassene Extender aus dem FileElement

exceptionSuffix - Dateien mit disem Extender werden nicht zurückgegeben.

Throws:

RQLException

See Also:

FileElement, File

searchFiles

public java.util.List<File> searchFiles(java.lang.String pattern,
                                        TemplateElement templateElement)
                                 throws RQLException

Liefert alle Files dieses Ordners, die dem pattern genügen. Achtung diese Liste kann sehr groß werden.

Parameters:

pattern - Teil des Names incl. Wildcards (*)

templateElement - bestimmt als zusätzliche Einschränkung die möglichen Extender

Throws:

RQLException

searchFiles

public java.util.List<File> searchFiles(java.lang.String pattern,
                                        TemplateElement templateElement,
                                        java.lang.String exceptionSuffix)
                                 throws RQLException

Liefert alle Files dieses Ordners, die dem pattern genügen. Achtung diese Liste kann sehr groß werden.

Parameters:

pattern - Teil des Names incl. Wildcards (*)

templateElement - bestimmt als zusätzliche Einschränkung die möglichen Extender

exceptionSuffix - Dateien mit disem Extender werden nicht zurückgegeben.

Throws:

RQLException