de.xima.fc.plugin.models.config

Class AConfigParam

java.lang.Object

de.xima.fc.plugin.models.config.AConfigParam

All Implemented Interfaces:

IBasicConfigParam, Serializable

Direct Known Subclasses:

BundleConfigGroupItem, BundleConfigParam, PluginConfigGroupItem, PluginConfigParam

public abstract class AConfigParam
extends Object
implements IBasicConfigParam, Serializable

Referenz Implementierung für die IPluginConfigParam - Schnittstelle

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	crypticValue
protected String	defaultValue
protected Set<String>	dependentMandatoryParamNames
protected String	description
protected boolean	mandatory
protected String	name
protected boolean	nameEditable

Constructor Summary

Constructors

Constructor and Description
AConfigParam(String name)
AConfigParam(String name, boolean mandatory)
AConfigParam(String name, String description, boolean mandatory)

Method Summary

Modifier and Type	Method and Description
void	addDependentMandatoryParamName(String dependentMandatoryParamName)
boolean	equals(Object obj)
String	getDefaultValue() Ermöglicht die Festlegung eines Defaultwertes, der als initialer Parameterwert gesetzt werden soll.
Set<String>	getDependentMandatoryParamNames() Liefert ein Set mit Parameternamen, die ebenfalls zu Pflichtfeldern werden, wenn aktuelles Feld einen Wert besitzt
String	getDescription() Beschreibung, welche die Verwendung des Parameters näher erläutert und in der Oberfläche dargestellt werden kann
String	getName() The technical name of this parameter, it should not be localized, e.g.
int	hashCode()
boolean	isCrypticValue() Legt fest, ob das Feld für die Parameter-Value-Eingabe als Passwortfeld darzustellen ist.
boolean	isGroupItem() Legt fest, ob der Parameter als Gruppierungüberschrift dient.
boolean	isMandatory() Legt fest, ob Parameter in Oberfläche als Pflichtfeld dargestellt werden soll
boolean	isNameEditable() Legt fest, ob Parametername in Oberfläche änderbar sein soll
void	setCrypticValue(boolean crypticValue)
void	setDefaultValue(String defaultValue)
void	setDependentMandatoryParamNames(String[] dependentMandatoryParamNames)
void	setDescription(String description)
void	setMandatory(boolean mandatory)
void	setName(String name)
void	setNameEditable(boolean nameEditable)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.xima.fc.plugin.config.IBasicConfigParam

getDisplayName

Field Detail

name

protected String name

description

protected String description

mandatory

protected boolean mandatory

nameEditable

protected boolean nameEditable

crypticValue

protected boolean crypticValue

defaultValue

protected String defaultValue

dependentMandatoryParamNames

protected Set<String> dependentMandatoryParamNames

Constructor Detail

AConfigParam

public AConfigParam(String name)

AConfigParam

public AConfigParam(String name,
                    boolean mandatory)

AConfigParam

public AConfigParam(String name,
                    String description,
                    boolean mandatory)

Method Detail

getName

public String getName()

Description copied from interface: IBasicConfigParam

The technical name of this parameter, it should not be localized, e.g. myplugin.config.param.1.

Specified by:

getName in interface IBasicConfigParam

Returns:

The identifying name of this parameter.

setName

public void setName(String name)

getDescription

public String getDescription()

Description copied from interface: IBasicConfigParam

Beschreibung, welche die Verwendung des Parameters näher erläutert und in der Oberfläche dargestellt werden kann

Specified by:

getDescription in interface IBasicConfigParam

Returns:

eine Zeichenkette oder null

setDescription

public void setDescription(String description)

isMandatory

public boolean isMandatory()

Description copied from interface: IBasicConfigParam

Legt fest, ob Parameter in Oberfläche als Pflichtfeld dargestellt werden soll

Specified by:

isMandatory in interface IBasicConfigParam

Returns:

true wenn als Pflichtfeld dargestellt, sonst false

setMandatory

public void setMandatory(boolean mandatory)

isNameEditable

public boolean isNameEditable()

Description copied from interface: IBasicConfigParam

Legt fest, ob Parametername in Oberfläche änderbar sein soll

Specified by:

isNameEditable in interface IBasicConfigParam

Returns:

true wenn der Parametername in der Oberfläche editierbar sein soll, sonst false

isCrypticValue

public boolean isCrypticValue()

Description copied from interface: IBasicConfigParam

Legt fest, ob das Feld für die Parameter-Value-Eingabe als Passwortfeld darzustellen ist.

Specified by:

isCrypticValue in interface IBasicConfigParam

Returns:

true wenn Feld in der Oberfläche als Passwortfeld dargestellt werden soll, sonst false

setNameEditable

public void setNameEditable(boolean nameEditable)

setCrypticValue

public void setCrypticValue(boolean crypticValue)

getDefaultValue

public String getDefaultValue()

Description copied from interface: IBasicConfigParam

Ermöglicht die Festlegung eines Defaultwertes, der als initialer Parameterwert gesetzt werden soll.

Specified by:

getDefaultValue in interface IBasicConfigParam

Returns:

eine Zeichenkette oder null

setDefaultValue

public void setDefaultValue(String defaultValue)

getDependentMandatoryParamNames

public Set<String> getDependentMandatoryParamNames()

Description copied from interface: IBasicConfigParam

Liefert ein Set mit Parameternamen, die ebenfalls zu Pflichtfeldern werden, wenn aktuelles Feld einen Wert besitzt

Specified by:

getDependentMandatoryParamNames in interface IBasicConfigParam

Returns:

Set von Parameternamen oder null

setDependentMandatoryParamNames

public void setDependentMandatoryParamNames(String[] dependentMandatoryParamNames)

addDependentMandatoryParamName

public void addDependentMandatoryParamName(String dependentMandatoryParamName)

isGroupItem

public boolean isGroupItem()

Description copied from interface: IBasicConfigParam

Legt fest, ob der Parameter als Gruppierungüberschrift dient. Dann hat er folgende Eigenschaften:

• - er ist nicht editierbar
• - er kann nicht gelöscht werden
• - er wird nicht validiert

Specified by:

isGroupItem in interface IBasicConfigParam

Returns:

true wenn es sich bei dem zugrundeliegenden Element um ein Strukturierungselement handelt, sonst false

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object