com.hlcl.rql.as
Class Plugin

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

All Implemented Interfaces:

CmsClientContainer

public class Plugin
extends java.lang.Object
implements CmsClientContainer

Diese Klasse beschreibt ein Plugin.

Author:

LEJAFR

Constructor Summary

Plugin(CmsClient client, java.lang.String pluginGuid, java.lang.String active0or1, java.lang.String name)
Vollständiger Konstruktor mit allen Attributen.

Method Summary

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.
void	equalizeLabelsAccordingTo(UserInterfaceLanguage mainLanguage) Kopiert den Bezeichner für die gegebene mainLanguage in alle anderen Oberflächensprachen.
boolean	equals(java.lang.Object obj) Plugins mit der gleichen GUID werden als gleich betrachtet.
CmsClient	getCmsClient() Liefert den CmsClient.
java.lang.String	getLabel(UserInterfaceLanguage language) Liefert den in Menüs angezeigten Bezeichner dieses Plugins für die gegebene Sprache.
java.lang.String	getLogonGuid() Liefert die RedDot logon GUID des users unter dem das script läuft.
java.lang.String	getName()
java.lang.String	getPluginGuid()
int	hashCode() Returns a hash code value for the object.
boolean	isActive()
void	setIsActive(boolean isActive) Ändert die Eigenschaft active dieses Plugins.
java.lang.String	toString() For debugging only.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Plugin

public Plugin(CmsClient client,
              java.lang.String pluginGuid,
              java.lang.String active0or1,
              java.lang.String name)

Vollständiger Konstruktor mit allen Attributen.

Parameters:

client - the cms client instance

pluginGuid - the GUID of this plugin

active - =1, if this plugin is currently active, sonst 0

name - the name of this plugin

Method Detail

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

equalizeLabelsAccordingTo

public void equalizeLabelsAccordingTo(UserInterfaceLanguage mainLanguage)
                               throws RQLException

Kopiert den Bezeichner für die gegebene mainLanguage in alle anderen Oberflächensprachen.

ACHTUNG: Im save RQL müssen im Tag DESCRIPTIONS alle Sprachen vorkommen, sonst werden diese gelöscht! Weiterhin muss active mitgegeben werden, sonst werden aktive deaktiviert!

Throws:

RQLException

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

equals

public boolean equals(java.lang.Object obj)

Plugins mit der gleichen GUID werden als gleich betrachtet.

Overrides:

equals in class java.lang.Object

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getLabel

public java.lang.String getLabel(UserInterfaceLanguage language)
                          throws RQLException

Liefert den in Menüs angezeigten Bezeichner dieses Plugins für die gegebene Sprache.

Liefert einen leeren String, falls kein Bezeichner definiert ist.

Throws:

RQLException

getLogonGuid

public java.lang.String getLogonGuid()

Liefert die RedDot logon GUID des users unter dem das script läuft.

Specified by:

getLogonGuid in interface CmsClientContainer

getName

public java.lang.String getName()

Returns:

Returns the name.

getPluginGuid

public java.lang.String getPluginGuid()

Returns:

Returns the pluginGuid.

isActive

public boolean isActive()

Returns:

Returns the active.

setIsActive

public void setIsActive(boolean isActive)
                 throws RQLException

Ändert die Eigenschaft active dieses Plugins.

Throws:

RQLException

toString

public java.lang.String toString()

For debugging only.

Overrides:

toString in class java.lang.Object