com.hlcl.rql.as
Class Template

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

All Implemented Interfaces:

CmsClientContainer, ProjectContainer, TemplateFolderContainer

public class Template
extends java.lang.Object
implements TemplateFolderContainer

Diese Klasse beschreibt ein RedDot Template.

Author:

LEJAFR

Constructor Summary

Template(TemplateFolder templateFolder, java.lang.String name, java.lang.String templateGuid, java.lang.String description)
Erzeugt ein neues Template.

Method Summary

void	addPlugins(java.util.Set<Plugin> pluginsToAdd) Lässt die gegebenen Plugins an diesem Template zu (assign plugins).
void	addPlugins(java.lang.String pluginNamePrefix) Ordnet alle Plugins deren Name mit dem gegebenen Prefix beginnen diesem Template zu (assign plugins).
void	assignAuthorizationPackageToPageElements(AuthorizationPackage authorizationPackage, TemplateElement templateElement, int maxPages) Ordnet den ersten maxPages Seiten dieses Templates je dem Seitenelement, das auf dem gegebenen templateElement basiert, das gegebenen Detail-Element-Berechtigungspaket zu.
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.
java.util.Set<Template>	collectPreassignedTemplatesOfAllMultiLinkElements(boolean includeReferences) Sammelt in ein Set alle vorbelegten Templates aller MultiLink Templateelemente dieses Templates.
boolean	contains(java.lang.String templateElementName) Liefert true genau dann, wenn dieses Template ein Element mit dem Namen templateElementName hat.
boolean	contains(TemplateElement templateElement) Liefert true genau dann, wenn dieses Template ein TemplateElement mit dem gleichen Namen wie das gegebene Templateelement beinhaltet.
void	copyElementFrom(TemplateElement templateElement) Adds a copy of given content class element to this content class.
void	copyElementsFrom(java.util.List<TemplateElement> templateElements) Adds a copy of all given content class elements to this content class.
void	copyElementsFrom(Template sourceTemplate, java.lang.String namePrefix) Adds a copy of all given content class elements with the given prefix from the source content class.
java.lang.String	createStandardFieldText(java.lang.String templateElementName, java.lang.String label, boolean isLanguageDependent) Erstellt ein neues Standardfeld Text an diesem Template.
void	deleteTemplateElementByName(java.lang.String name) Löscht das Templateelement mit dem gegebenen Namen.
void	deleteTemplateElements(java.lang.String elementNames, java.lang.String delimiter) Löscht alle gegebenen Templateelemente elementNames, die durch delimiter getrennt sein müssen.
boolean	equals(java.lang.Object obj) Templates mit der gleichen GUID werden als gleich betrachtet.
AdministrationElement	getAdministrationElementByName(java.lang.String name) Liefert das Administrations-Element mit dem gegebenen Namen vom CMS zurück.
PageArrayList	getAllPages(int maxPages) Gibt alle Seiten zurück, die auf diesem Template basieren.
java.util.List<TemplateElement>	getAsciiTextTemplateElements() Liefert eine java.util.List von Ascii Text Templateelementen.
java.util.Set<Plugin>	getAssignedPlugins() Liefert die zugeordneten Plugins dieses Templates.
java.util.List<TemplateElement>	getAttributeTemplateElements() Liefert eine java.util.List von Attribute Templateelementen.
CmsClient	getCmsClient() Liefert den CmsClient.
java.util.List<TemplateElement>	getContainerTemplateElements() Liefert eine java.util.List von Container Templateelementen.
java.util.List<TemplateElement>	getContentElements() Liefert alle Inhalts-Templateelemente dieses Templates inklusive Headline-Elemente und referenzierter Elemente.
java.util.List<TemplateElement>	getContentElements(boolean includeHeadline, boolean includeReferences) Liefert alle Inhalts-Templateelemente dieses Templates abhängig von den gegeben Werten.
java.util.List<TemplateElement>	getContentElements(boolean includeHeadline, boolean includeReferences, java.lang.String ignoreElementNames, java.lang.String separator) Liefert alle Inhalts-Templateelemente dieses Templates abhängig von den gegeben Werten.
java.lang.String	getDescription() Liefert die Beschreibung dieses Templates.
java.util.List<TemplateElement>	getFrameTemplateElements() Liefert eine java.util.List von Frame Templateelementen.
java.util.List<TemplateElement>	getHeadlineTemplateElements() Liefert eine java.util.List von Headline Templateelementen.
java.util.List<TemplateElement>	getHtmlTextTemplateElements() Liefert eine java.util.List von HTML Text Templateelementen.
java.util.List<TemplateElement>	getImageTemplateElements() Liefert eine java.util.List von Image Templateelementen.
java.util.List<TemplateElement>	getInfoTemplateElements() Liefert eine java.util.List von Info Templateelementen.
java.util.List<TemplateElement>	getLabeledTemplateElements() Liefert eine java.util.List Templateelemente, die ein Label (RD nennt das Feld description) haben.
java.util.List<TemplateElement>	getLanguageVariantDependentTemplateElements() Liefert alle Templateelemente dieses Templates, die Sprachvariantenabhängig sind.
java.util.List<TemplateElement>	getLanguageVariantIndependentTemplateElements() Liefert alle Templateelemente dieses Templates, die Sprachvariantenunabhängig sind.
java.util.List<TemplateElement>	getListTemplateElements() Liefert eine java.util.List von List Templateelementen.
java.lang.String	getLogonGuid() Liefert die Logon GUID vom Container.
java.util.List<TemplateElement>	getMediaTemplateElements() Liefert eine java.util.List von Media Templateelementen.
java.util.List	getMultiLinkTemplateElements() Liefert alle MultiLink Templateelemente.
java.util.List<TemplateElement>	getMultiLinkTemplateElements(boolean includeReferences) Liefert alle MultiLink Templateelemente.
java.util.List<TemplateElement>	getMultiLinkTemplateElements(java.util.List names) Liefert alle MultiLink Templateelemente mit vorgegebenen namen.
java.lang.String	getName() Liefert den Namen der content class.
java.util.List<TemplateElement>	getOptionListTemplateElements() Liefert eine java.util.List von OptionList Templateelementen.
java.lang.String	getPrefixName() Liefert den Prefixnamen dieses Templates.
Project	getProject() Liefert das Projekt.
java.lang.String	getProjectGuid() Liefert die RedDot GUID des Projekts.
TemplatePublishAssignment	getPublishAssignment(ProjectVariant projectVariant) Liefert die Publishing-Zuordnung für die gegebene Projektvariante oder null, falls keine gefunden wurde.
TemplatePublishAssignment	getPublishAssignment(java.lang.String projectVariantGuid) Liefert die Publishing-Zuordnung für die gegebene Guid der Projektvariante oder null, falls keine definiert sind (keine TemplateVarianten).
java.util.List<TemplatePublishAssignment>	getPublishAssignments() Liefert für alle Projektvarianten die Publishing-Zuordnungen.
java.util.List<TemplatePublishAssignment>	getPublishAssignments(java.lang.String projectVariantNamePart) Liefert alle Publishing-Zuordnungen dieses Templates, deren Projektvariante projectVariantPart enthält, check with contains().
TemplateVariant	getPublishedTemplateVariantFor(ProjectVariant projectVariant) Liefert die TemplateVariante dieses Templates, die für die gegebene Projektvariante gepublished wird.
TemplateVariant	getPublishedTemplateVariantFor(java.lang.String projectVariantGuid) Liefert die TemplateVariante dieses Templates, die für die gegebene Projektvariante gepublished wird.
java.lang.String	getSessionKey() Liefert den RedDot Session key.
java.lang.String	getShadowedTemplateElementGuids(java.lang.String shadowElementsNameSuffix, java.lang.String delimiter) Liefert eine Liste der GUIDs aller Templateelemente, für die es Elemente mit deren Namen + shadowElementsNameSuffix gibt.
java.util.List<TemplateElement>	getShadowedTemplateElements(java.lang.String shadowElementsNameSuffix) Liefert eine Liste aller Templateelemente, für die es Elemente mit deren Namen + shadowElementsNameSuffix gibt.
java.lang.String	getSmartEditTemplateCode() Liefert den Templatecode der Templatevariante zurück, die für die Display format Projektvariante konfiguriert ist.
java.util.List<TemplateElement>	getStandardFieldDateTemplateElements() Liefert eine java.util.List von StandardField Date Templateelementen.
java.util.List<TemplateElement>	getStandardFieldNumericTemplateElements() Liefert eine java.util.List von StandardField Numeric Templateelementen.
java.util.List<TemplateElement>	getStandardFieldTextTemplateElements() Liefert eine java.util.List von StandardField Text Templateelementen.
TemplateElement	getTemplateElementByGuid(java.lang.String templateElementGuid) Liefert das Templateelement mit der gegebenen GUID vom CMS zurück.
TemplateElement	getTemplateElementByName(java.lang.String name) Liefert das Templateelement mit dem gegebenen Namen vom CMS zurück.
java.util.List<TemplateElement>	getTemplateElements() Liefert alle Templateelemente dieses Templates.
java.util.List<TemplateElement>	getTemplateElementsByPrefix(java.lang.String namePrefix) Liefert eine Liste aller Templateelemente, deren Name mit dem gegebenen Prefix beginnen, case sensitiv.
java.util.List<TemplateElement>	getTemplateElementsBySuffix(java.lang.String nameSuffix) Liefert eine Liste aller Templateelemente, deren Name mit dem gegebenen Suffix enden, case sensitiv.
java.util.List<TemplateElement>	getTemplateElementsByType(int type) Liefert alle Templateelemente des gegebenen Typs.
java.util.List<TemplateElement>	getTemplateElementsByType(int type, java.lang.String elementNamePattern) Liefert alle Templateelemente des gegebenen Typs und Namens.
TemplateFolder	getTemplateFolder() Liefert den Template-Folder, in dem dieses Template enthalten ist.
java.lang.String	getTemplateFolderGuid() Liefert die Template Folder GUID.
java.lang.String	getTemplateFolderName() Liefert den Namen des Template Folders.
java.lang.String	getTemplateGuid() Insert the method's description here.
TemplateVariant	getTemplateVariantByGuid(java.lang.String templateVariantGuid) Liefert die TemplateVariante mit der gegebenen GUID zurück.
TemplateVariant	getTemplateVariantByName(java.lang.String templateVariantName) Liefert die TemplateVariante mit dem gegebenen Namen zurück oder null falls nicht gefunden.
java.util.List<java.lang.String>	getTemplateVariantNames() Liefert die Namen aller TemplateVarianten dieses Templates.
java.lang.String	getTemplateVariantNames(java.lang.String separator) Liefert die Namen aller TemplateVarianten dieses Templates separiert mit dem gegebenen separator.
java.util.List<TemplateVariant>	getTemplateVariants() Liefert alle TemplateVarianten dieses Templates.
java.util.List<TemplateElement>	getTextAnchorTemplateElements() Liefert eine java.util.List von Text Anchor Templateelementen.
java.util.List<TemplateElement>	getTextTemplateElements() Liefert eine java.util.List von Text Templateelementen, sowohl Ascii als auch HTML Text-Templatelementen.
java.util.List<TemplateElement>	getUnusedTemplateElements() Liefert alle Elemente dieses Templates, die in keiner Templatevariante (im SourceCode) verwendet werden.
boolean	hasAdministrationElement(java.lang.String name) Liefert true, falls dieses Template ein Admin element mit dem gegebenen Namen hat.
int	hashCode() HashCode wir auf GUID zurückgeführt.
boolean	isElementChangeableInSmartEditByName(java.lang.String elementName) Liefert true, falls das gegebenen TemplateElement einen roten Punkt im SmartEdit HTML code besitzt, sonst false.
boolean	isElementChangeableInSmartEditByName(TemplateElement templateElement) Liefert true, falls das gegebenen TemplateElement einen roten Punkt im SmartEdit HTML code besitzt, sonst false.
boolean	isNameEndsWith(java.lang.String templateNameSuffix) Liefert true, falls der Name mit dem gegebenen Suffix endet.
boolean	isNameEquals(java.lang.String... templateNames) Liefert true, falls der Name dieses Templates mit mindestens einem der gegebenen Namen übereinstimmt.
boolean	isNameStartsWith(java.lang.String... templateNamePrefixes) Liefert true, falls der Name dieses Templates mit mindestens einem der gegebenen Namen beginnt.
void	referencePageElements(TemplateElement templateElement, StandardFieldTextElement targetElement, int maxPages) Zieht eine Referenz in den ersten maxPages Seiten dieses Templates zu je dem Seitenelement, das auf dem gegebenen templateElement basiert.
void	referencePageElements(TemplateElement templateElement, TextElement targetElement, int maxPages) Zieht eine Referenz in den ersten maxPages Seiten dieses Templates zu je dem Seitenelement, das auf dem gegebenen templateElement basiert.
void	referencePageLinks(TemplateElement templateElement, MultiLink targetLink, int maxPages) Zieht eine Referenz in den ersten maxPages Seiten dieses Templates zu je dem Seitenlink, das auf dem gegebenen templateElement basiert.
void	removeAllPlugins() Entfernt alle zugeordneten Plugins von diesem Template (assign plugins).
void	removePlugins(java.util.Set<Plugin> pluginsToRemove) Entfernt die gegebenen Plugins von diesem Template (assign plugins).
void	setPlugins(java.util.Set<Plugin> assignedPlugins) Lässt nur die gegebenen Plugins an diesem Template zu (assign plugins); alle anderen werden deaktiviert.
TemplatePublishAssignment	setPublishAssignment(ProjectVariant projectVariant, boolean publish) Ändert an der TemplateVariante dieses Templates mit dem gegebenen Namen, ob diese TemplateVariante gepublished wird oder nicht.
boolean	setPublishAssignment(java.lang.String projectVariantPart, boolean publish) Ändert für alle PublishAssignments mit dem gegebenen project variant partial name (check with contains()), das publish yes or no setting.
java.lang.String	toString() For debugging only.
boolean	usesTemplateElement(java.lang.String elementName) Liefert true, falls das gegebene Element elementName in keiner TemplateVariante im Quellcode verwendet wird oder einen roten Punkt enthält.
boolean	usesTemplateElement(TemplateElement element) Liefert true, falls das gegebene Element element in keiner TemplateVariante im Quellcode verwendet wird oder einen roten Punkt enthält.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Template

public Template(TemplateFolder templateFolder,
                java.lang.String name,
                java.lang.String templateGuid,
                java.lang.String description)

Erzeugt ein neues Template.

Parameters:

templateFolder - Verzeichnis, in dem dieses Template gespeichert ist

name - Name dieses Templates

templateGuid - RedDot GUID dieses Templates

description - Beschreibung dieses Templates

Method Detail

assignAuthorizationPackageToPageElements

public void assignAuthorizationPackageToPageElements(AuthorizationPackage authorizationPackage,
                                                     TemplateElement templateElement,
                                                     int maxPages)
                                              throws RQLException

Ordnet den ersten maxPages Seiten dieses Templates je dem Seitenelement, das auf dem gegebenen templateElement basiert, das gegebenen Detail-Element-Berechtigungspaket zu.

Throws:

RQLException

removeAllPlugins

public void removeAllPlugins()
                      throws RQLException

Entfernt alle zugeordneten Plugins von diesem Template (assign plugins).

Throws:

RQLException

removePlugins

public void removePlugins(java.util.Set<Plugin> pluginsToRemove)
                   throws RQLException

Entfernt die gegebenen Plugins von diesem Template (assign plugins). Lässt andere Zuordnungen unverändert; ist subtraktiv.

Die gegebenen Plugins müssen dem Projekt zugeordnet sein!

Throws:

RQLException

setPlugins

public void setPlugins(java.util.Set<Plugin> assignedPlugins)
                throws RQLException

Lässt nur die gegebenen Plugins an diesem Template zu (assign plugins); alle anderen werden deaktiviert.

Die gegebenen Plugins müssen dem Projekt zugeordnet sein!

Throws:

RQLException

addPlugins

public void addPlugins(java.util.Set<Plugin> pluginsToAdd)
                throws RQLException

Lässt die gegebenen Plugins an diesem Template zu (assign plugins). Lässt andere Zuordnungen unverändert; ist additiv.

Die gegebenen Plugins müssen dem Projekt zugeordnet sein!

Throws:

RQLException

addPlugins

public void addPlugins(java.lang.String pluginNamePrefix)
                throws RQLException

Ordnet alle Plugins deren Name mit dem gegebenen Prefix beginnen diesem Template zu (assign plugins).

Lässt andere Zuordnungen unverändert; ist additiv.

Die gegebenen Plugins müssen dem Projekt zugeordnet sein!

Throws:

RQLException

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

isNameEndsWith

public boolean isNameEndsWith(java.lang.String templateNameSuffix)
                       throws RQLException

Liefert true, falls der Name mit dem gegebenen Suffix endet.

Throws:

RQLException

isNameStartsWith

public boolean isNameStartsWith(java.lang.String... templateNamePrefixes)
                         throws RQLException

Liefert true, falls der Name dieses Templates mit mindestens einem der gegebenen Namen beginnt.

Throws:

RQLException

isNameEquals

public boolean isNameEquals(java.lang.String... templateNames)
                     throws RQLException

Liefert true, falls der Name dieses Templates mit mindestens einem der gegebenen Namen übereinstimmt.

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

collectPreassignedTemplatesOfAllMultiLinkElements

public java.util.Set<Template> collectPreassignedTemplatesOfAllMultiLinkElements(boolean includeReferences)
                                                                          throws RQLException

Sammelt in ein Set alle vorbelegten Templates aller MultiLink Templateelemente dieses Templates.

Parameters:

includeReferences - =true, auch Elemente, die Referenzquelle sind werden geliefert (haben keine Childs!) =false, ohne Element, die Referenzquelle sind (nur diese haben Childs!)

Returns:

java.util.Set of Templates

Throws:

RQLException

copyElementsFrom

public void copyElementsFrom(Template sourceTemplate,
                             java.lang.String namePrefix)
                      throws RQLException

Adds a copy of all given content class elements with the given prefix from the source content class.

Attention: Following will not be copied: Default and sample texts, child element of and references.

Throws:

RQLException

copyElementsFrom

public void copyElementsFrom(java.util.List<TemplateElement> templateElements)
                      throws RQLException

Adds a copy of all given content class elements to this content class.

Attention: Following will not be copied: Default and sample texts, child element of and references.

Throws:

RQLException

copyElementFrom

public void copyElementFrom(TemplateElement templateElement)
                     throws RQLException

Adds a copy of given content class element to this content class.

Throws:

RQLException

contains

public boolean contains(java.lang.String templateElementName)
                 throws RQLException

Liefert true genau dann, wenn dieses Template ein Element mit dem Namen templateElementName hat.

Throws:

RQLException

contains

public boolean contains(TemplateElement templateElement)
                 throws RQLException

Liefert true genau dann, wenn dieses Template ein TemplateElement mit dem gleichen Namen wie das gegebene Templateelement beinhaltet.

Throws:

RQLException

createStandardFieldText

public java.lang.String createStandardFieldText(java.lang.String templateElementName,
                                                java.lang.String label,
                                                boolean isLanguageDependent)
                                         throws RQLException

Erstellt ein neues Standardfeld Text an diesem Template.

Liefert, mangels Konstruktur in Klasse TemplateElement, nur die ElementGUID des angelegten Elements zurück.

Throws:

RQLException

deleteTemplateElementByName

public void deleteTemplateElementByName(java.lang.String name)
                                 throws RQLException

Löscht das Templateelement mit dem gegebenen Namen.

Parameters:

name - Name des Templateelementes.

Throws:

RQLException

deleteTemplateElements

public void deleteTemplateElements(java.lang.String elementNames,
                                   java.lang.String delimiter)
                            throws RQLException

Löscht alle gegebenen Templateelemente elementNames, die durch delimiter getrennt sein müssen.

Throws:

RQLException

equals

public boolean equals(java.lang.Object obj)

Templates mit der gleichen GUID werden als gleich betrachtet.

Overrides:

equals in class java.lang.Object

getAdministrationElementByName

public AdministrationElement getAdministrationElementByName(java.lang.String name)
                                                     throws RQLException

Liefert das Administrations-Element mit dem gegebenen Namen vom CMS zurück.

Parameters:

name - Name des Administrations-Element

Returns:

TemplateElement

Throws:

RQLException

See Also:

TemplateElement

getAllPages

public PageArrayList getAllPages(int maxPages)
                          throws RQLException

Gibt alle Seiten zurück, die auf diesem Template basieren. Das Ergebnis könnte sehr groß werden. Benötigt den session key!

Returns:

List of Pages

Throws:

RQLException

getAsciiTextTemplateElements

public java.util.List<TemplateElement> getAsciiTextTemplateElements()
                                                             throws RQLException

Liefert eine java.util.List von Ascii Text Templateelementen.

Throws:

RQLException

getAssignedPlugins

public java.util.Set<Plugin> getAssignedPlugins()
                                         throws RQLException

Liefert die zugeordneten Plugins dieses Templates.

Throws:

RQLException

getAttributeTemplateElements

public java.util.List<TemplateElement> getAttributeTemplateElements()
                                                             throws RQLException

Liefert eine java.util.List von Attribute Templateelementen.

Throws:

RQLException

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getContainerTemplateElements

public java.util.List<TemplateElement> getContainerTemplateElements()
                                                             throws RQLException

Liefert eine java.util.List von Container Templateelementen.

Throws:

RQLException

getContentElements

public java.util.List<TemplateElement> getContentElements()
                                                   throws RQLException

Liefert alle Inhalts-Templateelemente dieses Templates inklusive Headline-Elemente und referenzierter Elemente.

Throws:

RQLException

getContentElements

public java.util.List<TemplateElement> getContentElements(boolean includeHeadline,
                                                          boolean includeReferences)
                                                   throws RQLException

Liefert alle Inhalts-Templateelemente dieses Templates abhängig von den gegeben Werten.

Throws:

RQLException

getContentElements

public java.util.List<TemplateElement> getContentElements(boolean includeHeadline,
                                                          boolean includeReferences,
                                                          java.lang.String ignoreElementNames,
                                                          java.lang.String separator)
                                                   throws RQLException

Liefert alle Inhalts-Templateelemente dieses Templates abhängig von den gegeben Werten.

Throws:

RQLException

getDescription

public java.lang.String getDescription()

Liefert die Beschreibung dieses Templates.

Returns:

java.lang.String

getFrameTemplateElements

public java.util.List<TemplateElement> getFrameTemplateElements()
                                                         throws RQLException

Liefert eine java.util.List von Frame Templateelementen.

Throws:

RQLException

getHeadlineTemplateElements

public java.util.List<TemplateElement> getHeadlineTemplateElements()
                                                            throws RQLException

Liefert eine java.util.List von Headline Templateelementen.

Throws:

RQLException

getHtmlTextTemplateElements

public java.util.List<TemplateElement> getHtmlTextTemplateElements()
                                                            throws RQLException

Liefert eine java.util.List von HTML Text Templateelementen.

Throws:

RQLException

getImageTemplateElements

public java.util.List<TemplateElement> getImageTemplateElements()
                                                         throws RQLException

Liefert eine java.util.List von Image Templateelementen.

Throws:

RQLException

getInfoTemplateElements

public java.util.List<TemplateElement> getInfoTemplateElements()
                                                        throws RQLException

Liefert eine java.util.List von Info Templateelementen.

Throws:

RQLException

getLabeledTemplateElements

public java.util.List<TemplateElement> getLabeledTemplateElements()
                                                           throws RQLException

Liefert eine java.util.List Templateelemente, die ein Label (RD nennt das Feld description) haben.

Throws:

RQLException

getLanguageVariantDependentTemplateElements

public java.util.List<TemplateElement> getLanguageVariantDependentTemplateElements()
                                                                            throws RQLException

Liefert alle Templateelemente dieses Templates, die Sprachvariantenabhängig sind.

Throws:

RQLException

getLanguageVariantIndependentTemplateElements

public java.util.List<TemplateElement> getLanguageVariantIndependentTemplateElements()
                                                                              throws RQLException

Liefert alle Templateelemente dieses Templates, die Sprachvariantenunabhängig sind.

Throws:

RQLException

getListTemplateElements

public java.util.List<TemplateElement> getListTemplateElements()
                                                        throws RQLException

Liefert eine java.util.List von List Templateelementen.

Throws:

RQLException

getLogonGuid

public java.lang.String getLogonGuid()

Liefert die Logon GUID vom Container.

Specified by:

getLogonGuid in interface CmsClientContainer

See Also:

Project

getMediaTemplateElements

public java.util.List<TemplateElement> getMediaTemplateElements()
                                                         throws RQLException

Liefert eine java.util.List von Media Templateelementen.

Throws:

RQLException

getMultiLinkTemplateElements

public java.util.List getMultiLinkTemplateElements()
                                            throws RQLException

Liefert alle MultiLink Templateelemente. MultiLinks, die Referenzquellen sind werden mitgeliefert.

Returns:

java.util.List of TemplateElements

Throws:

RQLException

getMultiLinkTemplateElements

public java.util.List<TemplateElement> getMultiLinkTemplateElements(boolean includeReferences)
                                                             throws RQLException

Liefert alle MultiLink Templateelemente.

Parameters:

includeReferences - =true, auch Elemente, die Referenzquelle sind werden geliefert (haben keine Childs!) =false, ohne Element, die Referenzquelle sind (nur diese haben Childs!)

Returns:

java.util.List of TemplateElements

Throws:

RQLException

getMultiLinkTemplateElements

public java.util.List<TemplateElement> getMultiLinkTemplateElements(java.util.List names)
                                                             throws RQLException

Liefert alle MultiLink Templateelemente mit vorgegebenen namen.

Parameters:

names - a List of template element names

Returns:

java.util.List of TemplateElements

Throws:

RQLException

getName

public java.lang.String getName()

Liefert den Namen der content class.

Returns:

java.lang.String

getOptionListTemplateElements

public java.util.List<TemplateElement> getOptionListTemplateElements()
                                                              throws RQLException

Liefert eine java.util.List von OptionList Templateelementen.

Throws:

RQLException

getPrefixName

public java.lang.String getPrefixName()
                               throws RQLException

Liefert den Prefixnamen dieses Templates. z.B. leaf_list_

Liefert null, falls kein Präfix definiert ist.

Throws:

RQLException

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

getPublishAssignment

public TemplatePublishAssignment getPublishAssignment(ProjectVariant projectVariant)
                                               throws RQLException

Liefert die Publishing-Zuordnung für die gegebene Projektvariante oder null, falls keine gefunden wurde.

Throws:

RQLException

getPublishAssignment

public TemplatePublishAssignment getPublishAssignment(java.lang.String projectVariantGuid)
                                               throws RQLException

Liefert die Publishing-Zuordnung für die gegebene Guid der Projektvariante oder null, falls keine definiert sind (keine TemplateVarianten).

Throws:

RQLException

getPublishAssignments

public java.util.List<TemplatePublishAssignment> getPublishAssignments()
                                                                throws RQLException

Liefert für alle Projektvarianten die Publishing-Zuordnungen.

Returns:

list of TemplatePublishAssignment

Throws:

RQLException

getPublishAssignments

public java.util.List<TemplatePublishAssignment> getPublishAssignments(java.lang.String projectVariantNamePart)
                                                                throws RQLException

Liefert alle Publishing-Zuordnungen dieses Templates, deren Projektvariante projectVariantPart enthält, check with contains().

Liefert eine leere Liste, falls keine gefunden wurde.

Throws:

RQLException

getPublishedTemplateVariantFor

public TemplateVariant getPublishedTemplateVariantFor(ProjectVariant projectVariant)
                                               throws RQLException

Liefert die TemplateVariante dieses Templates, die für die gegebene Projektvariante gepublished wird.

Throws:

RQLException

getPublishedTemplateVariantFor

public TemplateVariant getPublishedTemplateVariantFor(java.lang.String projectVariantGuid)
                                               throws RQLException

Liefert die TemplateVariante dieses Templates, die für die gegebene Projektvariante gepublished wird.

Throws:

RQLException

getSessionKey

public java.lang.String getSessionKey()

Liefert den RedDot Session key.

Specified by:

getSessionKey in interface ProjectContainer

getShadowedTemplateElementGuids

public java.lang.String getShadowedTemplateElementGuids(java.lang.String shadowElementsNameSuffix,
                                                        java.lang.String delimiter)
                                                 throws RQLException

Liefert eine Liste der GUIDs aller Templateelemente, für die es Elemente mit deren Namen + shadowElementsNameSuffix gibt. Liefert eine leere Liste, falls keine gefunden wurden. Beispiel: suffix = workflow_unlinked_flag Liste der Elemente, deren Namen auf diesen Suffix enden = list_of_section_workflow_unlinked_flag, media_files_workflow_unklinked_flag Methode liefert die GUIDs der TemplateElemente list_of_section und media_files, falls diese existieren.

Parameters:

shadowElementsNameSuffix - Suffix der Schattenelemente

Returns:

list of TemplateElement GUIDs

Throws:

RQLException

See Also:

getShadowedTemplateElements(String)

getShadowedTemplateElements

public java.util.List<TemplateElement> getShadowedTemplateElements(java.lang.String shadowElementsNameSuffix)
                                                            throws RQLException

Liefert eine Liste aller Templateelemente, für die es Elemente mit deren Namen + shadowElementsNameSuffix gibt. Liefert eine leere Liste, falls keine gefunden wurden. Beispiel: suffix = workflow_unlinked_flag Liste der Elemente, deren Namen auf diesen Suffix enden = list_of_section_workflow_unlinked_flag, media_files_workflow_unklinked_flag Methode liefert die TemplateElemente list_of_section und media_files, falls diese existieren.

Parameters:

shadowElementsNameSuffix - Suffix der Schattenelemente

Returns:

list of TemplateElements

Throws:

RQLException

See Also:

getShadowedTemplateElementGuids(String, String)

getSmartEditTemplateCode

public java.lang.String getSmartEditTemplateCode()
                                          throws RQLException

Liefert den Templatecode der Templatevariante zurück, die für die Display format Projektvariante konfiguriert ist.

Oder: Liefert den Templatecode zurück, der im SmartEdit angezeigt wird.

Throws:

RQLException

getStandardFieldDateTemplateElements

public java.util.List<TemplateElement> getStandardFieldDateTemplateElements()
                                                                     throws RQLException

Liefert eine java.util.List von StandardField Date Templateelementen.

Throws:

RQLException

getStandardFieldNumericTemplateElements

public java.util.List<TemplateElement> getStandardFieldNumericTemplateElements()
                                                                        throws RQLException

Liefert eine java.util.List von StandardField Numeric Templateelementen.

Throws:

RQLException

getStandardFieldTextTemplateElements

public java.util.List<TemplateElement> getStandardFieldTextTemplateElements()
                                                                     throws RQLException

Liefert eine java.util.List von StandardField Text Templateelementen.

Throws:

RQLException

getTemplateElementByGuid

public TemplateElement getTemplateElementByGuid(java.lang.String templateElementGuid)
                                         throws RQLException

Liefert das Templateelement mit der gegebenen GUID vom CMS zurück.

Parameters:

templateElementGuid - GUID des gesuchten Templateelementes.

Returns:

TemplateElement

Throws:

RQLException

See Also:

TemplateElement

getTemplateElementByName

public TemplateElement getTemplateElementByName(java.lang.String name)
                                         throws RQLException

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

Parameters:

name - Name des Templateelementes.

Returns:

TemplateElement

Throws:

RQLException

See Also:

TemplateElement

getTemplateElements

public java.util.List<TemplateElement> getTemplateElements()
                                                    throws RQLException

Liefert alle Templateelemente dieses Templates.

Throws:

RQLException

getTemplateElementsBySuffix

public java.util.List<TemplateElement> getTemplateElementsBySuffix(java.lang.String nameSuffix)
                                                            throws RQLException

Liefert eine Liste aller Templateelemente, deren Name mit dem gegebenen Suffix enden, case sensitiv.

Liefert eine leere Liste, falls keine gefunden wurden.

Parameters:

nameSuffix - Suffix der zu suchenden Elemente (z.B. workflow_unlinked_flag)

Returns:

list of TemplateElements

Throws:

RQLException

getTemplateElementsByPrefix

public java.util.List<TemplateElement> getTemplateElementsByPrefix(java.lang.String namePrefix)
                                                            throws RQLException

Liefert eine Liste aller Templateelemente, deren Name mit dem gegebenen Prefix beginnen, case sensitiv.

Liefert eine leere Liste, falls keine gefunden wurden.

Parameters:

namePrefix - Prefix der zu suchenden Elemente

Returns:

list of TemplateElements

Throws:

RQLException

getTemplateElementsByType

public java.util.List<TemplateElement> getTemplateElementsByType(int type)
                                                          throws RQLException

Liefert alle Templateelemente des gegebenen Typs.

Returns:

java.util.List of TemplateElements

Throws:

RQLException

See Also:

for possible types

getTemplateElementsByType

public java.util.List<TemplateElement> getTemplateElementsByType(int type,
                                                                 java.lang.String elementNamePattern)
                                                          throws RQLException

Liefert alle Templateelemente des gegebenen Typs und Namens.

Parameters:

elementNamePattern - Muster (mit genau einem wildcard *) für die Prüfung des Elementnamens, arbeitet case sensitive

Returns:

java.util.List of TemplateElements

Throws:

RQLException

See Also:

for possible types

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 die Template Folder GUID.

Specified by:

getTemplateFolderGuid in interface TemplateFolderContainer

Returns:

GUID des TemplateFolder

getTemplateFolderName

public java.lang.String getTemplateFolderName()

Liefert den Namen des Template Folders.

getTemplateGuid

public java.lang.String getTemplateGuid()

Insert the method's description here.

Returns:

java.lang.String

getTemplateVariantByGuid

public TemplateVariant getTemplateVariantByGuid(java.lang.String templateVariantGuid)
                                         throws RQLException

Liefert die TemplateVariante mit der gegebenen GUID zurück.

Parameters:

templateVariantGuid - GUID der gesuchten TemplateVariante.

Throws:

RQLException

getTemplateVariantByName

public TemplateVariant getTemplateVariantByName(java.lang.String templateVariantName)
                                         throws RQLException

Liefert die TemplateVariante mit dem gegebenen Namen zurück oder null falls nicht gefunden.

Parameters:

templateVariantName - Name der gesuchten TemplateVariante, z.B. HTML, DEL_XML, XML

Throws:

RQLException

getTemplateVariantNames

public java.util.List<java.lang.String> getTemplateVariantNames()
                                                         throws RQLException

Liefert die Namen aller TemplateVarianten dieses Templates.

Returns:

java.util.List of TemplateVariantNames

Throws:

RQLException

getTemplateVariantNames

public java.lang.String getTemplateVariantNames(java.lang.String separator)
                                         throws RQLException

Liefert die Namen aller TemplateVarianten dieses Templates separiert mit dem gegebenen separator.

Throws:

RQLException

getTemplateVariants

public java.util.List<TemplateVariant> getTemplateVariants()
                                                    throws RQLException

Liefert alle TemplateVarianten dieses Templates.

Returns:

java.util.List of TemplateVariants

Throws:

RQLException

getTextAnchorTemplateElements

public java.util.List<TemplateElement> getTextAnchorTemplateElements()
                                                              throws RQLException

Liefert eine java.util.List von Text Anchor Templateelementen.

Throws:

RQLException

getTextTemplateElements

public java.util.List<TemplateElement> getTextTemplateElements()
                                                        throws RQLException

Liefert eine java.util.List von Text Templateelementen, sowohl Ascii als auch HTML Text-Templatelementen.

Throws:

RQLException

getUnusedTemplateElements

public java.util.List<TemplateElement> getUnusedTemplateElements()
                                                          throws RQLException

Liefert alle Elemente dieses Templates, die in keiner Templatevariante (im SourceCode) verwendet werden.

D.h. diese Elemente haben in allen Templatevarianten auch keinen roten Punkt.

Throws:

RQLException

hasAdministrationElement

public boolean hasAdministrationElement(java.lang.String name)
                                 throws RQLException

Liefert true, falls dieses Template ein Admin element mit dem gegebenen Namen hat.

Throws:

RQLException

hashCode

public int hashCode()

HashCode wir auf GUID zurückgeführt.

Overrides:

hashCode in class java.lang.Object

isElementChangeableInSmartEditByName

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

Liefert true, falls das gegebenen TemplateElement einen roten Punkt im SmartEdit HTML code besitzt, sonst false.

Throws:

RQLException

isElementChangeableInSmartEditByName

public boolean isElementChangeableInSmartEditByName(TemplateElement templateElement)
                                             throws RQLException

Liefert true, falls das gegebenen TemplateElement einen roten Punkt im SmartEdit HTML code besitzt, sonst false.

Throws:

RQLException

referencePageElements

public void referencePageElements(TemplateElement templateElement,
                                  StandardFieldTextElement targetElement,
                                  int maxPages)
                           throws RQLException

Zieht eine Referenz in den ersten maxPages Seiten dieses Templates zu je dem Seitenelement, das auf dem gegebenen templateElement basiert.

Die Seitenelemente werden auf das gegebene targetElement verwiesen.

Throws:

RQLException

referencePageElements

public void referencePageElements(TemplateElement templateElement,
                                  TextElement targetElement,
                                  int maxPages)
                           throws RQLException

Zieht eine Referenz in den ersten maxPages Seiten dieses Templates zu je dem Seitenelement, das auf dem gegebenen templateElement basiert.

Die Seitenelemente werden auf das gegebene targetElement verwiesen.

Throws:

RQLException

referencePageLinks

public void referencePageLinks(TemplateElement templateElement,
                               MultiLink targetLink,
                               int maxPages)
                        throws RQLException

Zieht eine Referenz in den ersten maxPages Seiten dieses Templates zu je dem Seitenlink, das auf dem gegebenen templateElement basiert.

Die Seitenlinks werden auf den gegebenen targetLink verwiesen.

Throws:

RQLException

setPublishAssignment

public TemplatePublishAssignment setPublishAssignment(ProjectVariant projectVariant,
                                                      boolean publish)
                                               throws RQLException

Ändert an der TemplateVariante dieses Templates mit dem gegebenen Namen, ob diese TemplateVariante gepublished wird oder nicht. Die der TemplateVariante zugeordnete ProjectVariante wird nicht verändert!

Parameters:

projectVariant - die Projektvariante, für die publish geändert werden soll

Returns:

null, if no publishing assignment is found or the assignment, if the change was successful

Throws:

RQLException

setPublishAssignment

public boolean setPublishAssignment(java.lang.String projectVariantPart,
                                    boolean publish)
                             throws RQLException

Ändert für alle PublishAssignments mit dem gegebenen project variant partial name (check with contains()), das publish yes or no setting.

Returns:

true, if at least on setting was changed, otherwise false.

Throws:

RQLException

toString

public java.lang.String toString()

For debugging only.

Overrides:

toString in class java.lang.Object

usesTemplateElement

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

Liefert true, falls das gegebene Element elementName in keiner TemplateVariante im Quellcode verwendet wird oder einen roten Punkt enthält.

Throws:

RQLException

usesTemplateElement

public boolean usesTemplateElement(TemplateElement element)
                            throws RQLException

Liefert true, falls das gegebene Element element in keiner TemplateVariante im Quellcode verwendet wird oder einen roten Punkt enthält.

Throws:

RQLException