com.hlcl.rql.util.as
Class ScriptParameters

java.lang.Object
  com.hlcl.rql.util.as.ScriptParameters

public class ScriptParameters
extends java.lang.Object

Diese Klasse erleichtert den Zugriff auf Parameter eines Scripts. Diese werden in einer Seite vom Template rql_script gespeichert.

Author:

lejafr

Constructor Summary

ScriptParameters(Page scriptPage)
ScriptParameters constructor comment.

Method Summary

java.lang.String	get(java.lang.String parameterName) Liefert den Wert des Parameters mit dem gegebenen Namen zurück.
boolean	getBoolean(java.lang.String parameterName) Liefert den Wert des Parameters (nur true oder false) konvertiert nach boolean mit dem gegebenen Namen zurück.
int	getInt(java.lang.String parameterName) Liefert den Wert des Parameters konvertiert nach int mit dem gegebenen Namen zurück.
java.util.Set<java.lang.String>	getKeySet() Liefert das Set mit allen Keynamen des Parametermappings zurück.
java.util.SortedSet<java.lang.String>	getKeySetSorted() Liefert das Set mit allen Keynamen des Parametermappings sortiert zurück.
Project	getProject() Liefert das aktuelle Projekt.
boolean	isConnectedUserInUserGroup(java.lang.String userGroupName) RQL-seitige Prüfung ob ein User in einer Gruppe ist.
void	replaceInAllParameterValues(java.lang.String findValue, java.lang.String replaceValue) Ersetzt in allen Parameterwerten aller Parameter den gegebenen Wert find mit replace, falls find gefunden wurde.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptParameters

public ScriptParameters(Page scriptPage)

ScriptParameters constructor comment.

Method Detail

getInt

public int getInt(java.lang.String parameterName)
           throws RQLException

Liefert den Wert des Parameters konvertiert nach int mit dem gegebenen Namen zurück.

Throws:

RQLException

getBoolean

public boolean getBoolean(java.lang.String parameterName)
                   throws RQLException

Liefert den Wert des Parameters (nur true oder false) konvertiert nach boolean mit dem gegebenen Namen zurück.

Throws:

RQLException

get

public java.lang.String get(java.lang.String parameterName)
                     throws RQLException

Liefert den Wert des Parameters mit dem gegebenen Namen zurück.

Throws:

RQLException

getKeySet

public java.util.Set<java.lang.String> getKeySet()
                                          throws RQLException

Liefert das Set mit allen Keynamen des Parametermappings zurück.

Throws:

RQLException

getKeySetSorted

public java.util.SortedSet<java.lang.String> getKeySetSorted()
                                                      throws RQLException

Liefert das Set mit allen Keynamen des Parametermappings sortiert zurück.

Throws:

RQLException

isConnectedUserInUserGroup

public boolean isConnectedUserInUserGroup(java.lang.String userGroupName)
                                   throws RQLException

RQL-seitige Prüfung ob ein User in einer Gruppe ist.

Da normale Autoren keine Benutzergruppe/User aus dem ServerManager lesen können, wird die Zulassung eines Templates für die Prüfung mißbraucht.

Liefert true, falls das Template mit dem Namen UserGroupCheck_ im Ordner rql_templates für den angemeldeten Benutzer sichtbar ist.

Throws:

RQLException

replaceInAllParameterValues

public void replaceInAllParameterValues(java.lang.String findValue,
                                        java.lang.String replaceValue)
                                 throws RQLException

Ersetzt in allen Parameterwerten aller Parameter den gegebenen Wert find mit replace, falls find gefunden wurde.

Geänderte Seiten werden automatisch bestätigt. TODO eine private Klasse verwenden, um die Auslösung key - value zu kapseln

Throws:

RQLException

getProject

public Project getProject()
                   throws RQLException

Liefert das aktuelle Projekt.

Throws:

RQLException