|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.hlcl.rql.as.Project
public class Project
Diese Klasse beschreibt ein RedDot Projekt.
Constructor Summary | |
---|---|
Project(CmsClient cmsClient,
java.lang.String projectGuid)
Erzeugt ein neues Projekt. |
|
Project(CmsClient cmsClient,
java.lang.String sessionKey,
java.lang.String projectGuid)
Erzeugt ein neues Projekt. |
Method Summary | |
---|---|
PublishingJob |
activatePublishingJobByGuid(java.lang.String publishingJobGuid)
Aktiviert den definierten Publishing Job für die gegebene GUID und liefert den gefundenen Job zurück. |
void |
assignUsers(java.util.List<User> newUsers)
Berechtigt alle gegebenen User für dieses Projekt. |
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. |
PageSearch |
definePageSearch()
Liefert ein Seitensuch-Objekt zurück. |
void |
deletePageCache()
Löscht den Seitencache dieses Projekts vollständig. |
int |
deletePublishingJobReports(int daysToKeep)
Löscht Jobreports älter als die gegebene Anzahl von Tagen. |
java.util.List<PublishingTarget> |
disableFtpPublishingTargetsByNameContains(java.lang.String namePart)
Setzt in allen FTP publishing targets dieses Projekts, die namePart (check with contains=case sensitive) im Namen haben den FTP user name und Passwort = unknown. |
java.util.List<PublishingTarget> |
disableFtpPublishingTargetsByNameContains(java.lang.String namePart,
boolean ignoreCase)
Setzt in allen FTP publishing targets dieses Projekts, die namePart im Namen haben den FTP user name und Passwort = unknown. |
java.util.List<User> |
getActiveUsers()
Liefert eine List mit allen aktuell an diesem Projekt angemeldeten Usern. |
Affix |
getAffixByGuid(java.lang.String affixGuid)
Liefert den Affix aus den General Settings mit der gegebenen GUID. |
java.util.List<PublishingJob> |
getAllActivePublishingJobs()
Liefert alle aktiven vordefinierten PublishingJobs zurück. |
java.util.List<User> |
getAllConnectedUsers()
Liefert eine List mit allen gerade am Projekt angemeldeten Usern zurück. |
java.util.List<PublishingJob> |
getAllInactivePublishingJobs()
Liefert alle inaktiven vordefinierten PublishingJobs zurück. |
java.util.List<LanguageVariant> |
getAllLanguageVariants()
Liefert alle Sprachvarianten zurück. |
java.util.List<AuthorizationPackage> |
getAllPageAuthorizationPackages()
Liefert alle Berechtigunspakete vom Typ normal (=0) zurück. |
PageArrayList |
getAllPagesBasedOn(java.lang.String templateFolderName,
java.lang.String templateName,
int maxPages)
Gibt alle Seiten zurück, die auf dem gegebenen Template basieren. |
PageArrayList |
getAllPagesBasedOn(Template template,
int maxPages)
Gibt alle Seiten zurück, die auf dem gegebenen Template basieren. |
PageArrayList |
getAllPagesSavedAsDraft()
Liefert alle Seiten dieses Projektes im Status Entwurf. |
PageArrayList |
getAllPagesSavedAsDraftCreatedByUserGroup(UserGroup userGroup)
Liefert alle Seiten dieses Projektes (global) im Status Entwurf und die von einem Autor der gegebenen Benutzergruppe erstellt wurde. |
PageArrayList |
getAllPagesWaitingForCorrection()
Liefert alle Seiten dieses Projektes, die auf Korrektur stehen. |
PageArrayList |
getAllPagesWaitingForCorrectionCreatedByUserGroup(UserGroup userGroup)
Liefert alle Seiten dieses Projektes (global), die auf Korrektur stehen und die von einem Autor der gegebenen Benutzergruppe erstellt wurde. |
PageArrayList |
getAllPagesWaitingForRelease()
Liefert alle Seiten dieses Projektes, die auf Freigabe warten. |
PageArrayList |
getAllPagesWithFilename()
Gibt alle Seiten zurück, die einen Dateinamen gesetzt haben. |
java.util.List<ProjectVariant> |
getAllProjectVariants()
Liefert alle Projektvarianten dieses Projekts zurück. |
java.util.List<PublicationPackage> |
getAllPublicationPackages()
Liefert alle PublicationPackages dieses Projektes. |
java.util.List<PublishingJobReport> |
getAllPublishingJobReports()
Liefert alle Jobreports dieses Projektes. |
java.util.List<PublishingJob> |
getAllPublishingJobs()
Liefert alle vordefinierten PublishingJobs zurück. |
java.util.List<TemplateFolder> |
getAllTemplateFolders()
Liefert alle TemplateFolder dieses Projektes zurück. |
java.util.List<Template> |
getAllTemplatesByFolderName(java.lang.String templateFolderName)
Liefert alle Templates aus dem TemplateFolder mit dem gegebenen Namen. |
java.util.List<Template> |
getAllTemplatesByFolderNames(java.lang.String... templateFolderNames)
Liefert alle Templates aus den gegebenen TemplateFoldern. |
PageArrayList |
getAllUnlinkedPagesSortedByModificationDateAsc(int maxPages)
Gibt alle freien (unverlinkten) Seiten zurück. |
java.util.List<java.lang.String> |
getAllUrls()
Liefert alle Urls auf allen Seiten dieses Projektes. |
java.util.List<User> |
getAllUsers()
Liefert eine List mit allen Usern dieses Projektes zurück. |
java.util.Set<User> |
getAllUsersForGroupsNameStartsWith(java.lang.String prefix)
Liefert alle Benutzer aus allen Gruppen dieses Projektes, deren Name mit dem prefix beginnen. |
AssetManagerFolder |
getAssetManagerByName(java.lang.String assetManagerFolderName)
Liefert den AssetManager-Ordner mit dem gegebenen Namen oder null, falls kein AssetManager für den Namen gefunden wurde. |
AuthorizationPackage |
getAuthorizationPackageForPageByGuid(java.lang.String authorizationPackageGuid)
Liefert das Berechtigungspaket (Typ=Normal=0, an Seiten) für die gegebene GUID zurück. |
AuthorizationPackage |
getAuthorizationPackageForPageByName(java.lang.String packageName)
Liefert das Berechtigungspaket (Typ=Normal=0, an Seiten) mit dem gegebenen Namen zurück. |
CmsClient |
getCmsClient()
Liefert den Container des Projectes. |
Container |
getContainerByGuid(java.lang.String linkGuid)
Erzeugt einen Container für die gegebene linkGuid. |
LanguageVariant |
getCurrentLanguageVariant()
Liefert die gerade im Projekt gewählte Sprachvariante zurück. |
AuthorizationPackage |
getDetailedAuthorizationPackageForAssetManagerAttributeByName(java.lang.String packageName)
Liefert das Detailberechtigungspaket (Typ=AssetManagerAttribute=4) mit dem gegebenen Namen zurück. |
AuthorizationPackage |
getDetailedAuthorizationPackageForElementByName(java.lang.String packageName)
Liefert das Detailberechtigungspaket (Typ=Element=4) mit dem gegebenen Namen zurück. |
AuthorizationPackage |
getDetailedAuthorizationPackageForLinkByName(java.lang.String packageName)
Liefert das Detailberechtigungspaket (Typ=Link=2) mit dem gegebenen Namen zurück. |
AuthorizationPackage |
getDetailedAuthorizationPackageForPageByName(java.lang.String packageName)
Liefert das Detailberechtigungspaket (Typ=Page=1) mit dem gegebenen Namen zurück. |
Folder |
getFolderByGuid(java.lang.String folderGuid)
Liefert den Dateiordner für die GUID folderGuid vom CMS zurück. |
Folder |
getFolderByName(java.lang.String name)
Liefert den Dateiordner mit dem gegebenen Namen vom CMS zurück. |
java.util.List<Folder> |
getFolders()
Liefert alle Ordner (TemplateFolder, FileFolder and AssetManager) dieses Projektes. |
LanguageVariant |
getLanguageVariantByGuid(java.lang.String languageVariantGuid)
Liefert die Sprachvariante mit der gegebenen GUID zurück. |
LanguageVariant |
getLanguageVariantByLanguage(java.lang.String languageCode)
Liefert die Sprachvariante für die gegebene Sprache zurück. |
LanguageVariant |
getLanguageVariantByName(java.lang.String languageVariantName)
Liefert die Sprachvariante mit dem gegebenen Namen zurück. |
LanguageVariant |
getLanguageVariantByRfcLanguageId(java.lang.String rfcLanguageId)
Liefert die Sprachvariante mit der gegebenen RFC language ID (z.B. |
List |
getListByGuid(java.lang.String linkGuid)
Erzeugt eine Liste für die gegebene linkGuid. |
java.lang.String |
getLogonGuid()
Liefert die RedDot logon GUID. |
LanguageVariant |
getMainLanguageVariant()
Liefert die Haupt-Sprachvariante im aktuellen Projekt zurück. |
java.lang.String |
getMainLanguageVariantGuid()
Liefert die GUID der Haupt-Sprachvariante im aktuellen Projekt zurück. |
java.lang.String |
getMainLanguageVariantName()
Liefert den Namen der Haupt-Sprachvariante im aktuellen Projekt zurück. |
MultiLink |
getMultiLinkByGuid(java.lang.String linkGuid)
Erzeugt einen MultiLink (Liste oder Container) für die gegebene linkGuid. |
java.lang.String |
getName()
Liefert den Namen des Projekts. |
int |
getNumberOfAllTemplates()
Liefert die Anzahl aller Templates dieses Projekts zurück. |
Page |
getPageByGuid(java.lang.String pageGuid)
Erzeugt eine Page für die gegebene pageGuid. |
Page |
getPageById(java.lang.String pageId)
Erzeugt eine Page für die gegebene page ID. |
ScriptParameters |
getParameters(java.lang.String parameterPageId)
Liefert ein script parameter objekt für die gegebenen Parameterseite. |
java.lang.String |
getProjectGuid()
Liefert die GUID dieses Projektes. |
ProjectVariant |
getProjectVariantByGuid(java.lang.String projectVariantGuid)
Liefert die Projektvariante für die gegebene GUID zurück. |
ProjectVariant |
getProjectVariantByName(java.lang.String projectVariantName)
Liefert die Projektvariante mit dem gegebenen Namen zurück. |
PublicationPackage |
getPublicationPackageByGuid(java.lang.String packageGuid)
Liefert das PublicationPackage zu der gegebenen GUID. |
PublicationPackage |
getPublicationPackageByName(java.lang.String packageName)
Liefert das PublicationPackage zu dem gegebenen Namen. |
PublicationFolder |
getPublicationRootFolderByGuid(java.lang.String publicationFolderGuid)
Liefert den Publication Folder zur gegebenen GUID, oder null, falls keiner auf root-Ebene gefunden werden konnte. |
PublicationFolder |
getPublicationRootFolderByName(java.lang.String publicationFolderName)
Liefert den Publication Folder mit dem gegebenen Namen, oder null, falls keiner mit dem Namen existiert aus den children der Publication Structure (=root folder). |
java.lang.String |
getPublicationSettingStandardExtension()
Liefert die Standard Extension aus dem Bereich File der Exporteinstellungen dieses Projekt (Administer Publication / Project / Edit general settings). |
boolean |
getPublicationSettingTargetContainerPagesUsesOwnFilenameOnly()
Liefert true, falls die im Dateinamen verwendet wird. |
java.lang.String |
getPublicationSettingTargetContainerSeparator()
Liefert den Separator zwischen den IDs für Targetcontainerseiten. |
boolean |
getPublicationSettingUseDefaultSeparatorInTargetContainers()
Liefert true, falls die im Dateinamen verwendet wird. |
boolean |
getPublicationSettingUseGuidInFilename()
Liefert true, falls die GUID im Dateinamen verwendet wird. |
boolean |
getPublicationSettingUsePageIdInFilename()
Liefert true, falls die page ID im Dateinamen verwendet wird. |
boolean |
getPublicationSettingUseThisSeparatorInTargetContainers()
Liefert true, falls die im Dateinamen verwendet wird. |
java.lang.String |
getPublicationSettingUseThisTargetContainerSeparator()
Liefert den Separator zwischen den IDs für Targetcontainerseiten. |
PublishingJob |
getPublishingJobByGuid(java.lang.String publishingJobGuid)
Liefert den definierten Publishing Job zur gegebenen GUID zurück. |
PublishingJob |
getPublishingJobByName(java.lang.String publishingJobName)
Liefert den definierten Publishing Job für den gegebenen Namen zurück. |
PublishingTarget |
getPublishingTargetByGuid(java.lang.String publishingTargetGuid)
Liefert das Exportziel fuer die gegebene Guid vom CMS zurück. |
PublishingTarget |
getPublishingTargetByNameStartsWith(java.lang.String publishingTargetNamePrefix)
Liefert das 1. |
java.util.List<PublishingTarget> |
getPublishingTargets()
Liefert alle Exportziele dieses Projekts zurück. |
RecycleBin |
getRecycleBin()
Liefert den Papierkorb dieses Projektes zurück. |
JobQueue |
getRunningPublishingJobs()
Liefert eine JobQueue mit allen aktuell laufenden publishing Jobs. |
java.lang.String |
getSessionKey()
Liefert den RedDot Session Key. |
Page |
getStartPage()
Liefert die Startseite dieses Projektes, falls mit Username und Passwort angemeldet wurde. |
java.lang.String |
getStartPageGuid()
Liefert die GUID der Startseite dieses Projektes, falls Anmeldung über user name and password. |
Template |
getTemplateByGuid(java.lang.String templateGuid)
Liefert das Template mit der gegebenen RedDot GUID vom CMS zurück. |
Template |
getTemplateByName(java.lang.String templateFolderName,
java.lang.String templateName)
Liefert das Template mit dem gegebenen Namen aus dem gegebenen template folder. |
TemplateFolder |
getTemplateFolderByGuid(java.lang.String templateFolderGuid)
Liefert den TemplateFolder fuer die gegebene Guid vom CMS zurück. |
TemplateFolder |
getTemplateFolderByName(java.lang.String name)
Liefert den TemplateFolder mit dem gegebenen Namen vom CMS zurück. |
UserGroup |
getUserGroupByGuid(java.lang.String userGroupGuid)
Liefert die Benutzergruppe zu der gegebenen GUID. |
UserGroup |
getUserGroupByName(java.lang.String userGroupName)
Liefert die Benutzergruppe mit dem gegebenen Namen. |
java.util.List<UserGroup> |
getUserGroups()
Liefert alle Benutzergruppen dieses Projektes. |
java.util.List<UserGroup> |
getUserGroupsNameStartsWith(java.lang.String prefix)
Liefert alle Benutzergruppen dieses Projektes, die mit dem prefix beginnen. |
JobQueue |
getWaitingPublishingJobs()
Liefert eine JobQueue mit allen aktuell auf den start wartenden publishing Jobs. |
Workflow |
getWorkflowByName(java.lang.String workflowName)
Liefert den Workflow mit dem gegebenen Namen zurück. |
void |
grantAuthorRight(java.util.List<User> users)
Macht alle gegebenen Benutzer in diesem Projekt zu Autoren. |
java.util.List<PublishingJob> |
inactivateAllPublishingJobs()
Deaktivert alle (aktuell aktiven) vordefinierten Publishing jobs und liefert die geänderten Jobs zurück. |
boolean |
isCurrentLanguageVariantMainLanguage()
Liefert true, falls die augenblickliche Sprachvariante die Hauptsprachvariante ist, sonst false. |
void |
lock(java.lang.String lockInformationMessage)
Sperrt dieses Projekt für alle Benutzer inkl. |
void |
logoutActiveUsers()
Abmelden aller an diesem Projekt angemeldeten Benutzer außer dem User, der das Script gestartet hat. |
void |
sendMailToActiveUsers(java.lang.String from,
java.lang.String subject,
java.lang.String message)
Sendet eine Mail an alle aktuall an diesem Projekt angemeldeten User. |
void |
sendMailToAllUsers(java.lang.String from,
java.lang.String subject,
java.lang.String message,
boolean isTest)
Sendet eine Mail an alle User dieses Projektes. |
void |
setClipboard(StandardFieldTextElement sftElement)
Fügt das gegebenen StandardFieldText Element ins Clipboard ein. |
void |
setCurrentLanguageVariant(LanguageVariant languageVariant)
Wechselt die aktuell ausgewählte Sprachvariante des angemeldeten Benutzers. |
void |
setCurrentLanguageVariantByRfcLanguageId(java.lang.String rfcLanguageId)
Wechselt die aktuell ausgewählte Sprachvariante des angemeldeten Benutzers. |
void |
startExportJob(java.lang.String targetPath,
boolean includeUsersAndGroups,
boolean sendMailToConnectedUserWhenFinished)
Started einen Job zum Exportieren des Projektes. |
LanguageVariant |
switchCurrentLanguageVariantToMainLanguage()
Ändert die aktuelle Sprachvariante auf die Hauptsprache und liefert die alte Sprachvariante für den restore zurück. |
void |
unlock()
Entsperrt dieses Projekt. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Project(CmsClient cmsClient, java.lang.String projectGuid)
cmsClient
- Referenz des CmsClient, zu dem das Projekt gehört.public Project(CmsClient cmsClient, java.lang.String sessionKey, java.lang.String projectGuid)
cmsClient
- Referenz des CMSClient, zu dem das Projekt gehört.sessionKey
- Der Session key beinhaltet die Anmeldung eines Benutzers an dieses Projekt.projectGuid
- GUID des ProjektesMethod Detail |
---|
public void assignUsers(java.util.List<User> newUsers) throws RQLException
RQLException
public RQLNode callCms(java.lang.String rqlRequest) throws RQLException
callCms
in interface CmsClientContainer
RQLException
public java.lang.String callCmsWithoutParsing(java.lang.String rqlRequest) throws RQLException
callCmsWithoutParsing
in interface CmsClientContainer
RQLException
public PageSearch definePageSearch()
public RecycleBin getRecycleBin()
public void deletePageCache() throws RQLException
RQLException
public int deletePublishingJobReports(int daysToKeep) throws RQLException
daysToKeep
- number of days for that job reports will not be deleted; = 2 means, that all reports older than 2 days will be deleted
RQLException
public java.util.List<User> getActiveUsers() throws RQLException
RQLException
getAllConnectedUsers()
public Affix getAffixByGuid(java.lang.String affixGuid) throws RQLException
affixGuid
- GUID des Prefixes oder Suffixes
RQLException
public java.util.List<User> getAllConnectedUsers() throws RQLException
RQLException
getActiveUsers()
public java.util.List<AuthorizationPackage> getAllPageAuthorizationPackages() throws RQLException
RQLException
public PageArrayList getAllPagesBasedOn(java.lang.String templateFolderName, java.lang.String templateName, int maxPages) throws RQLException
templateFolderName
- content class folder nametemplateName
- name of the conten classmaxPages
- maximum number of pages to return
RQLException
public PageArrayList getAllPagesBasedOn(Template template, int maxPages) throws RQLException
template
- Template, dessen Instanzen gesucht sind
RQLException
public PageArrayList getAllPagesSavedAsDraft() throws RQLException
RQLException
public PageArrayList getAllPagesSavedAsDraftCreatedByUserGroup(UserGroup userGroup) throws RQLException
RQLException
public PageArrayList getAllPagesWaitingForCorrection() throws RQLException
RQLException
public PageArrayList getAllPagesWaitingForCorrectionCreatedByUserGroup(UserGroup userGroup) throws RQLException
RQLException
public PageArrayList getAllPagesWaitingForRelease() throws RQLException
RQLException
public PageArrayList getAllPagesWithFilename() throws RQLException
RQLException
public java.util.List<PublicationPackage> getAllPublicationPackages() throws RQLException
RQLException
public java.util.List<PublishingJobReport> getAllPublishingJobReports() throws RQLException
RQLException
public java.util.List<TemplateFolder> getAllTemplateFolders() throws RQLException
RQLException
public PageArrayList getAllUnlinkedPagesSortedByModificationDateAsc(int maxPages) throws RQLException
RQLException
public java.util.List<java.lang.String> getAllUrls() throws RQLException
java.util.List of String
RQLException
public java.util.List<User> getAllUsers() throws RQLException
RQLException
public java.util.Set<User> getAllUsersForGroupsNameStartsWith(java.lang.String prefix) throws RQLException
java.util.List
of UserGroup
s
RQLException
public AssetManagerFolder getAssetManagerByName(java.lang.String assetManagerFolderName) throws RQLException
name
- Name des AssetManager-Ordners.
RQLException
Folder
public AuthorizationPackage getAuthorizationPackageForPageByGuid(java.lang.String authorizationPackageGuid) throws RQLException
ElementNotFoundException
RQLException
public AuthorizationPackage getAuthorizationPackageForPageByName(java.lang.String packageName) throws RQLException
packageName
- Name des Berechtigungspaketes (case ignored!)
ElementNotFoundException
RQLException
public CmsClient getCmsClient()
getCmsClient
in interface CmsClientContainer
public Container getContainerByGuid(java.lang.String linkGuid) throws RQLException
linkGuid
- RedDot GUID des Containers
RQLException
public LanguageVariant getCurrentLanguageVariant() throws RQLException
RQLException
public AuthorizationPackage getDetailedAuthorizationPackageForAssetManagerAttributeByName(java.lang.String packageName) throws RQLException
packageName
- Name des Detailberechtigungspaketes (case ignored!)
ElementNotFoundException
RQLException
public AuthorizationPackage getDetailedAuthorizationPackageForElementByName(java.lang.String packageName) throws RQLException
packageName
- Name des Detailberechtigungspaketes (case ignored!)
ElementNotFoundException
RQLException
public AuthorizationPackage getDetailedAuthorizationPackageForLinkByName(java.lang.String packageName) throws RQLException
packageName
- Name des Detailberechtigungspaketes (case ignored!)
ElementNotFoundException
RQLException
public AuthorizationPackage getDetailedAuthorizationPackageForPageByName(java.lang.String packageName) throws RQLException
packageName
- Name des Detailberechtigungspaketes (case ignored!)
ElementNotFoundException
RQLException
public Folder getFolderByGuid(java.lang.String folderGuid) throws RQLException
folderGuid
- GUID des Dateiordners.
RQLException
Folder
public Folder getFolderByName(java.lang.String name) throws RQLException
name
- Name des Dateiordners.
RQLException
Folder
public java.util.List<Folder> getFolders() throws RQLException
RQLException
public java.util.List<LanguageVariant> getAllLanguageVariants() throws RQLException
RQLException
public PublishingJob activatePublishingJobByGuid(java.lang.String publishingJobGuid) throws RQLException
ElementNotFoundException
RQLException
public PublishingJob getPublishingJobByGuid(java.lang.String publishingJobGuid) throws RQLException
RQLException
public PublishingJob getPublishingJobByName(java.lang.String publishingJobName) throws RQLException
RQLException
public LanguageVariant getLanguageVariantByGuid(java.lang.String languageVariantGuid) throws RQLException
languageVariantGuid
- GUID der gesuchten Sprachvariante
RQLException
public LanguageVariant getLanguageVariantByLanguage(java.lang.String languageCode) throws RQLException
languageCode
- Code der Sprache, z.b. ENG, DEU aus dem RD Dialog (case ignored!)
RQLException
public LanguageVariant getLanguageVariantByName(java.lang.String languageVariantName) throws RQLException
languageVariantName
- Name der Sprachvariante (case ignored!)
RQLException
public LanguageVariant getLanguageVariantByRfcLanguageId(java.lang.String rfcLanguageId) throws RQLException
RQLException
LanguageVariant.getRfcLanguageId()
public List getListByGuid(java.lang.String linkGuid) throws RQLException
linkGuid
- RedDot GUID der Liste
RQLException
public java.lang.String getLogonGuid()
getLogonGuid
in interface CmsClientContainer
public LanguageVariant getMainLanguageVariant() throws RQLException
RQLException
public java.lang.String getMainLanguageVariantName() throws RQLException
RQLException
public java.lang.String getMainLanguageVariantGuid() throws RQLException
RQLException
public MultiLink getMultiLinkByGuid(java.lang.String linkGuid) throws RQLException
linkGuid
- RedDot GUID des Links
RQLException
public java.lang.String getName() throws RQLException
RQLException
validate()
public int getNumberOfAllTemplates() throws RQLException
RQLException
public Page getPageByGuid(java.lang.String pageGuid) throws RQLException
pageGuid
- RedDot GUID der Seite
RQLException
public Page getPageById(java.lang.String pageId) throws RQLException
pageId
- RedDot ID der Seite
RQLException
public ScriptParameters getParameters(java.lang.String parameterPageId) throws RQLException
RQLException
public java.lang.String getProjectGuid()
public ProjectVariant getProjectVariantByGuid(java.lang.String projectVariantGuid) throws RQLException
projectVariantGuid
- GUID der gesuchten Projektvariante
RQLException
public java.util.List<ProjectVariant> getAllProjectVariants() throws RQLException
RQLException
public ProjectVariant getProjectVariantByName(java.lang.String projectVariantName) throws RQLException
projectVariantName
- Name der Projektvariante (case ignored!)
RQLException
public PublicationPackage getPublicationPackageByName(java.lang.String packageName) throws RQLException
packageName
- Name des Exportpaketes (case ignored!)
RQLException
public PublicationPackage getPublicationPackageByGuid(java.lang.String packageGuid) throws RQLException
packageGuid
- GUID des Exportpaketes
RQLException
public PublicationFolder getPublicationRootFolderByName(java.lang.String publicationFolderName) throws RQLException
Benötigt den session key! Checks with equalsIgnoreCase().
RQLException
public PublicationFolder getPublicationRootFolderByGuid(java.lang.String publicationFolderGuid) throws RQLException
Benötigt den session key!
RQLException
public java.lang.String getPublicationSettingStandardExtension() throws RQLException
RQLException
public boolean getPublicationSettingTargetContainerPagesUsesOwnFilenameOnly() throws RQLException
Pages displayed in target containers use page file names only.
RQLException
public java.lang.String getPublicationSettingTargetContainerSeparator() throws RQLException
Aus dem Bereich File der Exporteinstellungen dieses Projekt (Administer Publication / Project / Edit general settings).
Sollte nicht benutzt werden, wenn
RQLException
= true ist
public boolean getPublicationSettingUseDefaultSeparatorInTargetContainers() throws RQLException
Use default separators (_) for pages in target containers
RQLException
public boolean getPublicationSettingUseGuidInFilename() throws RQLException
RQLException
public boolean getPublicationSettingUsePageIdInFilename() throws RQLException
RQLException
public boolean getPublicationSettingUseThisSeparatorInTargetContainers() throws RQLException
Use this separator for pages in target containers.
Get the separator from
RQLException
getPublicationSettingUseThisTargetContainerSeparator()
public java.lang.String getPublicationSettingUseThisTargetContainerSeparator() throws RQLException
RQLException
= true ist
public PublishingTarget getPublishingTargetByGuid(java.lang.String publishingTargetGuid) throws RQLException
publishingTargetGuid
- GUID des Exportziels.
RQLException
public PublishingTarget getPublishingTargetByNameStartsWith(java.lang.String publishingTargetNamePrefix) throws RQLException
RQLException
public java.util.List<PublishingTarget> disableFtpPublishingTargetsByNameContains(java.lang.String namePart) throws RQLException
Eine Publizierung über diese Publizierungsziele ist danach nicht mehr möglich. Liefert die deaktivierten Ziele zurück. Benötigt den session key!
RQLException
public java.util.List<PublishingTarget> disableFtpPublishingTargetsByNameContains(java.lang.String namePart, boolean ignoreCase) throws RQLException
Eine Publizierung über diese Publizierungsziele ist danach nicht mehr möglich. Liefert die deaktivierten Ziele zurück. Benötigt den session key!
RQLException
public java.util.List<PublishingTarget> getPublishingTargets() throws RQLException
RQLException
public JobQueue getRunningPublishingJobs() throws RQLException
Kann nur von Administratoren verwendet werden!
RQLException
public java.lang.String getSessionKey()
Ist keine Session vorhanden, können nur Administrative Funktionen dieses Projektes genutzt werden.
checkSessionKey
public Page getStartPage() throws RQLException
RQLException
public java.lang.String getStartPageGuid() throws RQLException
RQLException
public Template getTemplateByGuid(java.lang.String templateGuid) throws RQLException
templateGuid
- RedDot GUID des Templates
RQLException
Template
public Template getTemplateByName(java.lang.String templateFolderName, java.lang.String templateName) throws RQLException
RQLException
public java.util.List<Template> getAllTemplatesByFolderNames(java.lang.String... templateFolderNames) throws RQLException
RQLException
public java.util.List<Template> getAllTemplatesByFolderName(java.lang.String templateFolderName) throws RQLException
RQLException
public TemplateFolder getTemplateFolderByGuid(java.lang.String templateFolderGuid) throws RQLException
templateFolderGuid
- GUID des Template Folder.
RQLException
TemplateFolder
public TemplateFolder getTemplateFolderByName(java.lang.String name) throws RQLException
name
- Name des Template Folder.
RQLException
TemplateFolder
public UserGroup getUserGroupByGuid(java.lang.String userGroupGuid) throws RQLException
ElementNotFoundException
RQLException
public UserGroup getUserGroupByName(java.lang.String userGroupName) throws RQLException
ElementNotFoundException
RQLException
public java.util.List<UserGroup> getUserGroups() throws RQLException
RQLException
public java.util.List<UserGroup> getUserGroupsNameStartsWith(java.lang.String prefix) throws RQLException
RQLException
public JobQueue getWaitingPublishingJobs() throws RQLException
Kann nur von Administratoren verwendet werden!
RQLException
public Workflow getWorkflowByName(java.lang.String workflowName) throws RQLException
workflowName
- Name des Workflows (case ignored!)
RQLException
public void grantAuthorRight(java.util.List<User> users) throws RQLException
Hat ein User bereits mehr Rechte (Editor, Site Builder oder Administrator) bleiben seine Rechte unverändert.
RQLException
public boolean isCurrentLanguageVariantMainLanguage() throws RQLException
RQLException
public void lock(java.lang.String lockInformationMessage) throws RQLException
lockInformationMessage
- Nachricht für Benutzer, die sich versuchen anzumelden.
RQLException
public void logoutActiveUsers() throws RQLException
RQLException
public void sendMailToActiveUsers(java.lang.String from, java.lang.String subject, java.lang.String message) throws RQLException
RQLException
public void sendMailToAllUsers(java.lang.String from, java.lang.String subject, java.lang.String message, boolean isTest) throws RQLException
RQLException
public void setClipboard(StandardFieldTextElement sftElement) throws RQLException
Achtung: Alle im Clipboard vorhandenen Einträge werden überschrieben!
RQLException
public void setCurrentLanguageVariant(LanguageVariant languageVariant) throws RQLException
RQLException
public void setCurrentLanguageVariantByRfcLanguageId(java.lang.String rfcLanguageId) throws RQLException
RQLException
public void startExportJob(java.lang.String targetPath, boolean includeUsersAndGroups, boolean sendMailToConnectedUserWhenFinished) throws RQLException
ACHTUNG: RedDot liefert nicht immer Fehlermeldungen, manchmal eine Errormail, aber selten was in LOG\Export!
targetPath
- der lokale pfad des Exportverzeichnisses. Er muss leer sein, wird, falls nicht da, angelegt! Bei einem Cluster immer in UNC
Notation, z.b. \\kswfrd01\cms_data\project_exports\includeUsersAndGroups
- bei true werden die User und Gruppen dieses Projektes mit exportiert, sonst nichtsendMailToConnectedUserWhenFinished
- =true, sendet dem gerade angemeldeten Benutzer eine Mail, wenn der Exporjob beendet ist; =false, kein Mailversand; Mailadresse muss
konfiguriert sein!
RQLException
public LanguageVariant switchCurrentLanguageVariantToMainLanguage() throws RQLException
Ist die augenblickliche Sprachvariante die Hauptsprache, wird sie nicht geändert und die Hauptsprache zurückgeliefert.
RQLException
isCurrentLanguageVariantMainLanguage()
,
setCurrentLanguageVariant(LanguageVariant)
public void unlock() throws RQLException
RQLException
public java.util.List<PublishingJob> getAllPublishingJobs() throws RQLException
RQLException
public java.util.List<PublishingJob> getAllActivePublishingJobs() throws RQLException
RQLException
public java.util.List<PublishingJob> getAllInactivePublishingJobs() throws RQLException
RQLException
public java.util.List<PublishingJob> inactivateAllPublishingJobs() throws RQLException
RQLException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |