Package de.xima.fc.plugin.models.params

Class DefaultParametersModel

java.lang.Object

de.xima.fc.plugin.models.params.DefaultParametersModel

All Implemented Interfaces:

IExtendedParameterModel, IParameterModel, Serializable

public final class DefaultParametersModel
extends Object
implements IExtendedParameterModel

Default POJO implementation of IExtendedParameterModel. Implements hash code and equals via getParamName().

Since:

8.0.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultParametersModel()	Creates a new empty parameters model with no name and value set yet.
DefaultParametersModel(String name, String value)	Creates a new parameters model with the given name and value.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Set<String>	getDependentMandatoryParamNames()
String	getParamBehavior()	Liefert die Aussage, ob es sich um einen Input-, Output oder nicht näher definierten Parameter handelt.
String	getParamDescription()	Liefert die bei der Parameterdefinition hinterlegte Beschreibung
String	getParamDisplayName()
String	getParamName()	Liefert den Namen des Parameter zurück.
String	getParamValue()	Liefert den Wert des Parameters zurück.
String	getValidationErrorMsg()
int	hashCode()
boolean	isDeletable()	Liefert die Aussage, ob der Parameter bei Anzeige in der Oberfläche gelöscht werden darf.
boolean	isDependentMandatory()
boolean	isGroupItem()
boolean	isParamMandatory()	Liefert die Aussage, ob es sich um einen Pflichtparamter handelt
boolean	isParamNameEditable()
boolean	isParamValueCryptic()
boolean	isValidationError()
void	setDeletable(boolean deletable)
void	setDependentMandatoryParamNames(Set<String> dependentMandatoryParamNames)
void	setGroupItem(boolean groupItem)
void	setParamBehavior(String paramBehavior)
void	setParamDescription(String paramDescription)
void	setParamDisplayName(String paramDisplayName)
void	setParamMandatory(boolean paramMandatory)	Ermöglicht das Setzen des Parameters als Pflichtparameter.
void	setParamName(String name)	Setzt den Namen des Parameters.
void	setParamNameEditable(boolean paramNameEditable)
void	setParamValue(String paramValue)	Setzt den Wert eines Parameter.
void	setParamValueCryptic(boolean crypticValue)
void	setValidationError(boolean validationError)
void	setValidationErrorMsg(String validationErrorMsg)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultParametersModel

public DefaultParametersModel()

Creates a new empty parameters model with no name and value set yet.

DefaultParametersModel

public DefaultParametersModel(String name,
 String value)

Creates a new parameters model with the given name and value. The display name is set to the name.

Parameters:

name - Name of the parameter.

value - Initial value of the parameter.

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getDependentMandatoryParamNames

public Set<String> getDependentMandatoryParamNames()

Specified by:

getDependentMandatoryParamNames in interface IExtendedParameterModel

getParamBehavior

public String getParamBehavior()

Description copied from interface: IParameterModel

Liefert die Aussage, ob es sich um einen Input-, Output oder nicht näher definierten Parameter handelt. Die möglichen Werte sind der Enum IPluginConfigParam.EPluginParamBehavior entnommen.

Specified by:

getParamBehavior in interface IParameterModel

Returns:

Eine Zeichenkette aus der Wert der Enum IPluginConfigParam.EPluginParamBehavior

getParamDescription

public String getParamDescription()

Description copied from interface: IParameterModel

Liefert die bei der Parameterdefinition hinterlegte Beschreibung

Specified by:

getParamDescription in interface IParameterModel

Returns:

eien erläuternde Beschreibung zum Parameter oder null

getParamDisplayName

public String getParamDisplayName()

Specified by:

getParamDisplayName in interface IParameterModel

Returns:

The name that should be displayed on the UI.

getParamName

public String getParamName()

Description copied from interface: IParameterModel

Liefert den Namen des Parameter zurück.

Specified by:

getParamName in interface IParameterModel

Returns:

den Parameternamen

getParamValue

public String getParamValue()

Description copied from interface: IParameterModel

Liefert den Wert des Parameters zurück.

Specified by:

getParamValue in interface IParameterModel

Returns:

den Wert des Parameter oder null

getValidationErrorMsg

public String getValidationErrorMsg()

Specified by:

getValidationErrorMsg in interface IExtendedParameterModel

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isDeletable

public boolean isDeletable()

Description copied from interface: IParameterModel

Liefert die Aussage, ob der Parameter bei Anzeige in der Oberfläche gelöscht werden darf.

Specified by:

isDeletable in interface IParameterModel

Returns:

true wenn ein Löschen möglich ist, false wenn nicht

isDependentMandatory

public boolean isDependentMandatory()

Specified by:

isDependentMandatory in interface IExtendedParameterModel

isGroupItem

public boolean isGroupItem()

Specified by:

isGroupItem in interface IExtendedParameterModel

isParamMandatory

public boolean isParamMandatory()

Description copied from interface: IParameterModel

Liefert die Aussage, ob es sich um einen Pflichtparamter handelt

Specified by:

isParamMandatory in interface IParameterModel

Returns:

true wenn es sich um eine Pflichtparameter handelt, sonst false

isParamNameEditable

public boolean isParamNameEditable()

Specified by:

isParamNameEditable in interface IExtendedParameterModel

isParamValueCryptic

public boolean isParamValueCryptic()

Specified by:

isParamValueCryptic in interface IExtendedParameterModel

isValidationError

public boolean isValidationError()

Specified by:

isValidationError in interface IExtendedParameterModel

setDeletable

public void setDeletable(boolean deletable)

Specified by:

setDeletable in interface IExtendedParameterModel

setDependentMandatoryParamNames

public void setDependentMandatoryParamNames(Set<String> dependentMandatoryParamNames)

Specified by:

setDependentMandatoryParamNames in interface IExtendedParameterModel

setGroupItem

public void setGroupItem(boolean groupItem)

Specified by:

setGroupItem in interface IExtendedParameterModel

setParamBehavior

public void setParamBehavior(String paramBehavior)

Specified by:

setParamBehavior in interface IExtendedParameterModel

setParamDescription

public void setParamDescription(String paramDescription)

Specified by:

setParamDescription in interface IExtendedParameterModel

setParamDisplayName

public void setParamDisplayName(String paramDisplayName)

Specified by:

setParamDisplayName in interface IParameterModel

Parameters:

paramDisplayName - The name that should be displayed on the UI.

setParamMandatory

public void setParamMandatory(boolean paramMandatory)

Description copied from interface: IParameterModel

Ermöglicht das Setzen des Parameters als Pflichtparameter.

Specified by:

setParamMandatory in interface IParameterModel

Parameters:

paramMandatory - true wenn der Parameter zu einem Pflichtparameter werden soll, sonst false

setParamName

public void setParamName(String name)

Description copied from interface: IParameterModel

Setzt den Namen des Parameters.

Specified by:

setParamName in interface IParameterModel

Parameters:

name - den Parameternamen

setParamNameEditable

public void setParamNameEditable(boolean paramNameEditable)

Specified by:

setParamNameEditable in interface IExtendedParameterModel

setParamValue

public void setParamValue(String paramValue)

Description copied from interface: IParameterModel

Setzt den Wert eines Parameter.

Specified by:

setParamValue in interface IParameterModel

Parameters:

paramValue - the value to set

setParamValueCryptic

public void setParamValueCryptic(boolean crypticValue)

Specified by:

setParamValueCryptic in interface IExtendedParameterModel

setValidationError

public void setValidationError(boolean validationError)

Specified by:

setValidationError in interface IExtendedParameterModel

setValidationErrorMsg

public void setValidationErrorMsg(String validationErrorMsg)

Specified by:

setValidationErrorMsg in interface IExtendedParameterModel

toString

public String toString()

Overrides:

toString in class Object