com.hlcl.rql.as
Class PageSearch

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

All Implemented Interfaces:

CmsClientContainer, ProjectContainer

public class PageSearch
extends java.lang.Object
implements ProjectContainer

Diese Klasse kapselt eine Seitensuchanfrage (RQL xsearch). Dabei lassen sich die Kriterien dynamisch zusammenbauen.

Author:

LEJAFR

Constructor Summary

PageSearch(Project project)
constructor to create a page search

Method Summary

void	addContentClassCriteriaEqual(Template contentClass) Fügt ein Suchkriterium hinzu.
void	addContentClassCriteriaNotEqual(Template contentClass) Fügt ein Suchkriterium hinzu.
void	addLastChangedOnCriteriaEqual(ReddotDate lastChangedOn) Fügt ein Suchkriterium hinzu.
void	addLastChangedOnCriteriaGreaterEqual(ReddotDate lastChangedOn) Fügt ein Suchkriterium hinzu.
void	addLastChangedOnCriteriaGreaterThan(ReddotDate lastChangedOn) Fügt ein Suchkriterium hinzu.
void	addLastChangedOnCriteriaLowerEqual(ReddotDate lastChangedOn) Fügt ein Suchkriterium hinzu.
void	addLastChangedOnCriteriaLowerThan(ReddotDate lastChangedOn) Fügt ein Suchkriterium hinzu.
void	addLastChangedOnCriteriaNotEqual(ReddotDate lastChangedOn) Fügt ein Suchkriterium hinzu.
void	addPageIdCriteriaEqual(java.lang.String pageId) Fügt ein Suchkriterium hinzu.
void	addStateCriteriaWaitingForTranslation(LanguageVariant sourceLanguage) Fügt ein Suchkriterium nach Seitenstatus hinzu.
void	addTypeCriteriaAllPages() Fügt ein Suchkriterium hinzu.
void	addTypeCriteriaLinkedAndUnlinkedPages() Fügt ein Suchkriterium hinzu.
void	addTypeCriteriaOnlyLinkedPages() Fügt ein Suchkriterium hinzu.
void	addTypeCriteriaOnlyPagesInRecycleBin() Fügt ein Suchkriterium hinzu.
void	addTypeCriteriaOnlyUnlinkedPages() Fügt ein Suchkriterium hinzu.
RQLNode	callCms(java.lang.String rqlRequest) Sendet 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.
int	countOnly() Liefert nur die Anzahl der passenden Seiten zurück.
CmsClient	getCmsClient() Liefert den CmsClient.
java.lang.String	getLogonGuid() Liefert die Logon GUID vom Container.
PageArrayList	getPages() Started die konfigurierte Seitensuche und liefert alle Seiten, die diesen Kriterien entsprechen, zurück.
PageArrayList	getPages(int maxPages) Started die konfigurierte Seitensuche und liefert alle Seiten, die diesen Kriterien entsprechen, zurück.
Project	getProject() Liefert das Project, den Container der Seite.
java.lang.String	getProjectGuid() Liefert die RedDot GUID des Projekts.
java.lang.String	getSessionKey() Liefert den RedDot Session key.
void	orderAscending() Fordert eine aufsteigende Sortierung.
void	orderByContentClass() Konfiguriert eine Sortierung nach Kontentklasse.
void	orderByCreatedOnDate() Konfiguriert eine Sortierung nach Erstellungsdatum.
void	orderByLastChangedOnDate() Konfiguriert eine Sortierung nach Änderungsdatum.
void	orderByPageHeadline() Konfiguriert eine Sortierung nach Seitenüberschrift.
void	orderByPageId() Konfiguriert eine Sortierung nach Seiten ID.
void	orderDescending() Fordert eine absteigende Sortierung.
int	size() Liefert nur die Anzahl der passenden Seiten zurück.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageSearch

public PageSearch(Project project)

constructor to create a page search

Method Detail

getPages

public PageArrayList getPages()
                       throws RQLException

Started die konfigurierte Seitensuche und liefert alle Seiten, die diesen Kriterien entsprechen, zurück. Achtung: Es werden alle Seiten geliefert!

Throws:

RQLException

getPages

public PageArrayList getPages(int maxPages)
                       throws RQLException

Started die konfigurierte Seitensuche und liefert alle Seiten, die diesen Kriterien entsprechen, zurück. Es werden maximal die Anzahl maxPages zurückgeliefert, auch wenn mehr Seiten zu dieser Suche passen.

Throws:

RQLException

countOnly

public int countOnly()
              throws RQLException

Liefert nur die Anzahl der passenden Seiten zurück.

Throws:

RQLException

size

public int size()
         throws RQLException

Liefert nur die Anzahl der passenden Seiten zurück.

Throws:

RQLException

callCms

public RQLNode callCms(java.lang.String rqlRequest)
                throws RQLException

Sendet 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

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getProject

public Project getProject()

Liefert das Project, den Container der Seite.

Specified by:

getProject in interface ProjectContainer

See Also:

Project

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

getLogonGuid

public java.lang.String getLogonGuid()

Liefert die Logon GUID vom Container.

Specified by:

getLogonGuid in interface CmsClientContainer

See Also:

Project

orderByLastChangedOnDate

public void orderByLastChangedOnDate()

Konfiguriert eine Sortierung nach Änderungsdatum.

orderByPageId

public void orderByPageId()

Konfiguriert eine Sortierung nach Seiten ID.

orderByPageHeadline

public void orderByPageHeadline()

Konfiguriert eine Sortierung nach Seitenüberschrift.

orderByCreatedOnDate

public void orderByCreatedOnDate()

Konfiguriert eine Sortierung nach Erstellungsdatum.

orderByContentClass

public void orderByContentClass()

Konfiguriert eine Sortierung nach Kontentklasse.

orderAscending

public void orderAscending()

Fordert eine aufsteigende Sortierung.

orderDescending

public void orderDescending()

Fordert eine absteigende Sortierung.

addTypeCriteriaOnlyLinkedPages

public void addTypeCriteriaOnlyLinkedPages()

Fügt ein Suchkriterium hinzu. Es werden nur verlinkte Seiten gesucht.

addTypeCriteriaOnlyUnlinkedPages

public void addTypeCriteriaOnlyUnlinkedPages()

Fügt ein Suchkriterium hinzu. Es werden nur unverlinkte Seiten gesucht.

addLastChangedOnCriteriaEqual

public void addLastChangedOnCriteriaEqual(ReddotDate lastChangedOn)

Fügt ein Suchkriterium hinzu. Es werden nur Seiten gesucht, deren letztes Änderungsdatum gleich dem gegebenen ist. Achtung: Da die Zeitangabe in diesem Datum immer mit eingeschlossen ist, kann man nicht einfach nur einen Tag finden.

addLastChangedOnCriteriaNotEqual

public void addLastChangedOnCriteriaNotEqual(ReddotDate lastChangedOn)

Fügt ein Suchkriterium hinzu. Es werden nur Seiten gesucht, deren letztes Änderungsdatum ungleich dem gegebenen ist. Achtung: Gleiche Problematik wie bei equal.

See Also:

addLastChangedOnCriteriaEqual(ReddotDate)

addLastChangedOnCriteriaGreaterThan

public void addLastChangedOnCriteriaGreaterThan(ReddotDate lastChangedOn)

Fügt ein Suchkriterium hinzu. Es werden nur Seiten gesucht, deren letztes Änderungsdatum größer dem gegebenen ist (=jünger).

addLastChangedOnCriteriaLowerThan

public void addLastChangedOnCriteriaLowerThan(ReddotDate lastChangedOn)

Fügt ein Suchkriterium hinzu. Es werden nur Seiten gesucht, deren letztes Änderungsdatum kleiner dem gegebenen ist (=älter).

addLastChangedOnCriteriaGreaterEqual

public void addLastChangedOnCriteriaGreaterEqual(ReddotDate lastChangedOn)

Fügt ein Suchkriterium hinzu. Es werden nur Seiten gesucht, deren letztes Änderungsdatum größer oder gleich dem gegebenen ist (=jünger).

addPageIdCriteriaEqual

public void addPageIdCriteriaEqual(java.lang.String pageId)

Fügt ein Suchkriterium hinzu. Es wird die Seite für die gegebenen Page ID gesucht.

addLastChangedOnCriteriaLowerEqual

public void addLastChangedOnCriteriaLowerEqual(ReddotDate lastChangedOn)

Fügt ein Suchkriterium hinzu. Es werden nur Seiten gesucht, deren letztes Änderungsdatum kleiner oder gleich als dem gegebenen ist (=älter).

addTypeCriteriaLinkedAndUnlinkedPages

public void addTypeCriteriaLinkedAndUnlinkedPages()

Fügt ein Suchkriterium hinzu. Es werden verlinkte und unverlinkte Seiten gesucht, aber keine Seiten im Papierkorb.

addTypeCriteriaAllPages

public void addTypeCriteriaAllPages()

Fügt ein Suchkriterium hinzu. Es werden verlinkte, unverlinkte und Seiten im Papierkorb gesucht.

Muss man wahrscheinlich nicht angeben.

addTypeCriteriaOnlyPagesInRecycleBin

public void addTypeCriteriaOnlyPagesInRecycleBin()

Fügt ein Suchkriterium hinzu. Es werden nur Seiten gesucht, die sich im Papierkorb.

addContentClassCriteriaEqual

public void addContentClassCriteriaEqual(Template contentClass)

Fügt ein Suchkriterium hinzu. Es werden nur Seiten dieses Templates gesucht.

addContentClassCriteriaNotEqual

public void addContentClassCriteriaNotEqual(Template contentClass)

Fügt ein Suchkriterium hinzu. Es werden nur Seiten gesucht, die nicht auf dem gegebenen Template basieren.

addStateCriteriaWaitingForTranslation

public void addStateCriteriaWaitingForTranslation(LanguageVariant sourceLanguage)

Fügt ein Suchkriterium nach Seitenstatus hinzu. Es werden nur Seiten gesucht, die sich im Übersetzungsworkflow befinden.