com.hlcl.rql.as
Class PublicationPackage

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

All Implemented Interfaces:

CmsClientContainer, ProjectContainer

public class PublicationPackage
extends java.lang.Object
implements ProjectContainer

Diese Klasse beschreibt ein Exportpaket.

Author:

LEJAFR

Constructor Summary

PublicationPackage(Project project, java.lang.String publicationPackageGuid, java.lang.String name)
constructor comment.

Method Summary

PublicationSetting	addSetting(ProjectVariant newProjectVariant, LanguageVariant languageVariant, ProjectVariant copyProjectVariant) Erzeugt ein neues ExportSetting für die gegebene Kombination newProjectVariant und languageVariant.
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(PublicationSetting publicationSetting) Liefert true genau dann, wenn dieses Exportpaket ein Exportsetting entsprechend dem gegebenen enthält.
boolean	containsSettingFor(ProjectVariant projectVariant, LanguageVariant languageVariant) Liefert true genau dann, wenn dieses Exportpaket ein Exportsetting für die gegebene Kombination besitzt.
void	deleteSettingsByProjectVariantName(java.lang.String projectVariantNamePart) Löscht alle ExportSettings für alle Projektvarianten, deren Name projectVariantNamePart enthält.
PublicationSetting	findSettingByProjectVariantNameAndLanguageCode(java.lang.String projectVariantName, java.lang.String languageCode) Liefert ein ExportSetting für die gegebene Kombination, wenn das Exportpaket sie besitzt.
void	freeOccupiedMemory() Gibt den Speicher aller Caches wieder frei für die GC.
CmsClient	getCmsClient() Liefert den CmsClient.
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 Project, zu dem dieser Folder gehoert.
java.lang.String	getProjectGuid() Liefert die RedDot GUID des Projekts.
java.lang.String	getPublicationPackageGuid() Liefert die GUID dieses Exportpaketes.
java.util.List<PublicationSetting>	getPublicationSettings() Liefert alle Exportsettings die an diesem Exportpaket aktiv sind, aber nicht die (Draft) Kombinationen.
java.lang.String	getSessionKey() Liefert den RedDot Session key.
PublicationSetting	getSettingFor(ProjectVariant projectVariant, LanguageVariant languageVariant) Liefert ein ExportSetting für die gegebene Kombination, wenn das Exportpaket sie besitzt.
PublicationSetting	getSettingFor(java.lang.String projectVariantGuid, java.lang.String languageVariantGuid) Liefert ein ExportSetting für die gegebene Kombination, wenn das Exportpaket sie besitzt.
java.util.List<PublicationSetting>	getSettingsByProjectVariantName(java.lang.String projectVariantNamePart) Liefert alle ExportSettings für alle Projektvarianten, deren Name projectVariantNamePart enthält.
boolean	isGlobal() Deprecated. Did not work in V7.5.0.33. Deliver same attributes within same segment tag what causes the xml parser to stop with an error.
java.lang.String	toString() Show name for easier debugging.

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicationPackage

public PublicationPackage(Project project,
                          java.lang.String publicationPackageGuid,
                          java.lang.String name)

constructor comment.

Method Detail

addSetting

public PublicationSetting addSetting(ProjectVariant newProjectVariant,
                                     LanguageVariant languageVariant,
                                     ProjectVariant copyProjectVariant)
                              throws RQLException

Erzeugt ein neues ExportSetting für die gegebene Kombination newProjectVariant und languageVariant.

Kopiert die Einstellungen für die neue Kombination (alle Folder) von der Kombination copyProjectVariant/newLanguageVariant.

Throws:

RQLException - falls es bereits ein setting für die anzulegende Kombination gibt.

RQLException - falls es kein setting gibt, von dem die Foldereinstellungen kopiert werden sollen

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(PublicationSetting publicationSetting)
                 throws RQLException

Liefert true genau dann, wenn dieses Exportpaket ein Exportsetting entsprechend dem gegebenen enthält.

Throws:

RQLException

containsSettingFor

public boolean containsSettingFor(ProjectVariant projectVariant,
                                  LanguageVariant languageVariant)
                           throws RQLException

Liefert true genau dann, wenn dieses Exportpaket ein Exportsetting für die gegebene Kombination besitzt.

Throws:

RQLException

deleteSettingsByProjectVariantName

public void deleteSettingsByProjectVariantName(java.lang.String projectVariantNamePart)
                                        throws RQLException

Löscht alle ExportSettings für alle Projektvarianten, deren Name projectVariantNamePart enthält.

Parameters:

projectVariantNamePart - Teil des Namens der Projektvariante (check with contains)

Throws:

RQLException

findSettingByProjectVariantNameAndLanguageCode

public PublicationSetting findSettingByProjectVariantNameAndLanguageCode(java.lang.String projectVariantName,
                                                                         java.lang.String languageCode)
                                                                  throws RQLException

Liefert ein ExportSetting für die gegebene Kombination, wenn das Exportpaket sie besitzt. Sonst wird null geliefert.

Parameters:

projectVariantName - Name der Projektvariante

languageCode - internal Language ID, e.g. ENG, CHS, DEU

Returns:

ExportSetting or null, if not exists

Throws:

RQLException

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

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 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

getPublicationPackageGuid

public java.lang.String getPublicationPackageGuid()

Liefert die GUID dieses Exportpaketes.

Returns:

java.lang.String

getPublicationSettings

public java.util.List<PublicationSetting> getPublicationSettings()
                                                          throws RQLException

Liefert alle Exportsettings die an diesem Exportpaket aktiv sind, aber nicht die (Draft) Kombinationen.

Throws:

RQLException

getSessionKey

public java.lang.String getSessionKey()

Liefert den RedDot Session key.

Specified by:

getSessionKey in interface ProjectContainer

getSettingFor

public PublicationSetting getSettingFor(ProjectVariant projectVariant,
                                        LanguageVariant languageVariant)
                                 throws RQLException

Liefert ein ExportSetting für die gegebene Kombination, wenn das Exportpaket sie besitzt. Sonst wird null geliefert.

Throws:

RQLException

getSettingFor

public PublicationSetting getSettingFor(java.lang.String projectVariantGuid,
                                        java.lang.String languageVariantGuid)
                                 throws RQLException

Liefert ein ExportSetting für die gegebene Kombination, wenn das Exportpaket sie besitzt. Sonst wird null geliefert.

Throws:

RQLException

getSettingsByProjectVariantName

public java.util.List<PublicationSetting> getSettingsByProjectVariantName(java.lang.String projectVariantNamePart)
                                                                   throws RQLException

Liefert alle ExportSettings für alle Projektvarianten, deren Name projectVariantNamePart enthält.

Parameters:

projectVariantNamePart - Teil des Namens der Projektvariante (check with contains, case sensitive)

Throws:

RQLException

isGlobal

public boolean isGlobal()
                 throws RQLException

Deprecated. Did not work in V7.5.0.33. Deliver same attributes within same segment tag what causes the xml parser to stop with an error.

Liefert true, falls dieses Exportpaket ein globales ist.

Throws:

RQLException

freeOccupiedMemory

public void freeOccupiedMemory()

Gibt den Speicher aller Caches wieder frei für die GC. Dieses Exportpaket bleibt trotzdem voll funktionsfähig!

toString

public java.lang.String toString()

Show name for easier debugging.

Overrides:

toString in class java.lang.Object