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 ofIExtendedParameterModel
. Implements hash code and equals viagetParamName()
.- 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
All Methods Instance Methods Concrete Methods 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 BeschreibungString
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 handeltboolean
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()
-
-
-
Constructor Detail
-
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. Thedisplay name
is set to thename
.- Parameters:
name
- Name of the parameter.value
- Initial value of the parameter.
-
-
Method Detail
-
getDependentMandatoryParamNames
public Set<String> getDependentMandatoryParamNames()
- Specified by:
getDependentMandatoryParamNames
in interfaceIExtendedParameterModel
-
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 EnumIPluginConfigParam.EPluginParamBehavior
entnommen.- Specified by:
getParamBehavior
in interfaceIParameterModel
- 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 interfaceIParameterModel
- Returns:
- eien erläuternde Beschreibung zum Parameter oder null
-
getParamDisplayName
public String getParamDisplayName()
- Specified by:
getParamDisplayName
in interfaceIParameterModel
- 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 interfaceIParameterModel
- Returns:
- den Parameternamen
-
getParamValue
public String getParamValue()
Description copied from interface:IParameterModel
Liefert den Wert des Parameters zurück.- Specified by:
getParamValue
in interfaceIParameterModel
- Returns:
- den Wert des Parameter oder null
-
getValidationErrorMsg
public String getValidationErrorMsg()
- Specified by:
getValidationErrorMsg
in interfaceIExtendedParameterModel
-
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 interfaceIParameterModel
- Returns:
true
wenn ein Löschen möglich ist,false
wenn nicht
-
isDependentMandatory
public boolean isDependentMandatory()
- Specified by:
isDependentMandatory
in interfaceIExtendedParameterModel
-
isGroupItem
public boolean isGroupItem()
- Specified by:
isGroupItem
in interfaceIExtendedParameterModel
-
isParamMandatory
public boolean isParamMandatory()
Description copied from interface:IParameterModel
Liefert die Aussage, ob es sich um einen Pflichtparamter handelt- Specified by:
isParamMandatory
in interfaceIParameterModel
- Returns:
true
wenn es sich um eine Pflichtparameter handelt, sonstfalse
-
isParamNameEditable
public boolean isParamNameEditable()
- Specified by:
isParamNameEditable
in interfaceIExtendedParameterModel
-
isParamValueCryptic
public boolean isParamValueCryptic()
- Specified by:
isParamValueCryptic
in interfaceIExtendedParameterModel
-
isValidationError
public boolean isValidationError()
- Specified by:
isValidationError
in interfaceIExtendedParameterModel
-
setDeletable
public void setDeletable(boolean deletable)
- Specified by:
setDeletable
in interfaceIExtendedParameterModel
-
setDependentMandatoryParamNames
public void setDependentMandatoryParamNames(Set<String> dependentMandatoryParamNames)
- Specified by:
setDependentMandatoryParamNames
in interfaceIExtendedParameterModel
-
setGroupItem
public void setGroupItem(boolean groupItem)
- Specified by:
setGroupItem
in interfaceIExtendedParameterModel
-
setParamBehavior
public void setParamBehavior(String paramBehavior)
- Specified by:
setParamBehavior
in interfaceIExtendedParameterModel
-
setParamDescription
public void setParamDescription(String paramDescription)
- Specified by:
setParamDescription
in interfaceIExtendedParameterModel
-
setParamDisplayName
public void setParamDisplayName(String paramDisplayName)
- Specified by:
setParamDisplayName
in interfaceIParameterModel
- 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 interfaceIParameterModel
- Parameters:
paramMandatory
-true
wenn der Parameter zu einem Pflichtparameter werden soll, sonstfalse
-
setParamName
public void setParamName(String name)
Description copied from interface:IParameterModel
Setzt den Namen des Parameters.- Specified by:
setParamName
in interfaceIParameterModel
- Parameters:
name
- den Parameternamen
-
setParamNameEditable
public void setParamNameEditable(boolean paramNameEditable)
- Specified by:
setParamNameEditable
in interfaceIExtendedParameterModel
-
setParamValue
public void setParamValue(String paramValue)
Description copied from interface:IParameterModel
Setzt den Wert eines Parameter.- Specified by:
setParamValue
in interfaceIParameterModel
- Parameters:
paramValue
- the value to set
-
setParamValueCryptic
public void setParamValueCryptic(boolean crypticValue)
- Specified by:
setParamValueCryptic
in interfaceIExtendedParameterModel
-
setValidationError
public void setValidationError(boolean validationError)
- Specified by:
setValidationError
in interfaceIExtendedParameterModel
-
setValidationErrorMsg
public void setValidationErrorMsg(String validationErrorMsg)
- Specified by:
setValidationErrorMsg
in interfaceIExtendedParameterModel
-
-