de.xima.fc.plugin.models.config

Class PluginConfigParam

java.lang.Object

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

de.xima.fc.plugin.models.config.PluginConfigParam

All Implemented Interfaces:

IBasicConfigParam, IPluginConfigParam, Serializable

public class PluginConfigParam
extends AConfigParam
implements IPluginConfigParam, Serializable

Referenz Implementierung für die IPluginConfigParam - Schnittstelle

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.xima.fc.plugin.config.IPluginConfigParam

IPluginConfigParam.EPluginParamBehavior

Field Summary

Fields inherited from class de.xima.fc.plugin.models.config.AConfigParam

crypticValue, defaultValue, dependentMandatoryParamNames, description, mandatory, name, nameEditable

Constructor Summary

Constructors

Constructor and Description
PluginConfigParam(String name) Definiert Parameter intern als: - kein Pflichtfeld - Eingabeparamter
PluginConfigParam(String name, boolean mandatory) Definiert Parameter intern als: - Eingabeparamter
PluginConfigParam(String name, boolean mandatory, String defaultValue) Definiert Parameter intern als: - Eingabeparamter
PluginConfigParam(String name, boolean mandatory, String[] dependentMandatoryParams)
PluginConfigParam(String name, String defaultValue) Definiert Parameter intern als: - kein Pflichtfeld - Eingabeparamter
PluginConfigParam(String name, String description, boolean mandatory, IPluginConfigParam.EPluginParamBehavior behavior)
PluginConfigParam(String name, String description, boolean mandatory, IPluginConfigParam.EPluginParamBehavior behavior, String defaultValue)
PluginConfigParam(String name, String description, boolean mandatory, String[] dependentMandatoryParams, IPluginConfigParam.EPluginParamBehavior behavior)
PluginConfigParam(String name, String description, boolean mandatory, String[] dependentMandatoryParams, IPluginConfigParam.EPluginParamBehavior behavior, String defaultValue)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
IPluginConfigParam.EPluginParamBehavior	getBehavior() Liefert das Aussage, wie der Parameter innerhalb der Pluginlogik interprertiert wird, also ob es sich um einen Input- oder Output-Parameter handelt.
int	hashCode()
void	setBehavior(IPluginConfigParam.EPluginParamBehavior paramBehavior)
String	toString()

Methods inherited from class de.xima.fc.plugin.models.config.AConfigParam

addDependentMandatoryParamName, getDefaultValue, getDependentMandatoryParamNames, getDescription, getName, isCrypticValue, isGroupItem, isMandatory, isNameEditable, setCrypticValue, setDefaultValue, setDependentMandatoryParamNames, setDescription, setMandatory, setName, setNameEditable

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

getDefaultValue, getDependentMandatoryParamNames, getDescription, getDisplayName, getName, isCrypticValue, isGroupItem, isMandatory, isNameEditable

Constructor Detail

PluginConfigParam

public PluginConfigParam(String name)

Definiert Parameter intern als: - kein Pflichtfeld - Eingabeparamter

Parameters:

name - the name of the parameter

PluginConfigParam

public PluginConfigParam(String name,
                         String defaultValue)

Definiert Parameter intern als: - kein Pflichtfeld - Eingabeparamter

Parameters:

name - the name of the parameter

defaultValue - the default value of the parameter

Since:

version 4.3.0

PluginConfigParam

public PluginConfigParam(String name,
                         boolean mandatory)

Definiert Parameter intern als: - Eingabeparamter

Parameters:

name - the name of the parameter

mandatory - an flag to indicate if the parameter is mandatory

PluginConfigParam

public PluginConfigParam(String name,
                         boolean mandatory,
                         String defaultValue)

Definiert Parameter intern als: - Eingabeparamter

Parameters:

name - the name of the parameter

mandatory - an flag to indicate if the parameter is mandatory

defaultValue - the default value of the parameter

Since:

version 4.3.0

PluginConfigParam

public PluginConfigParam(String name,
                         boolean mandatory,
                         String[] dependentMandatoryParams)

PluginConfigParam

public PluginConfigParam(String name,
                         String description,
                         boolean mandatory,
                         IPluginConfigParam.EPluginParamBehavior behavior)

PluginConfigParam

public PluginConfigParam(String name,
                         String description,
                         boolean mandatory,
                         IPluginConfigParam.EPluginParamBehavior behavior,
                         String defaultValue)

Since:

version 4.3.0

PluginConfigParam

public PluginConfigParam(String name,
                         String description,
                         boolean mandatory,
                         String[] dependentMandatoryParams,
                         IPluginConfigParam.EPluginParamBehavior behavior)

PluginConfigParam

public PluginConfigParam(String name,
                         String description,
                         boolean mandatory,
                         String[] dependentMandatoryParams,
                         IPluginConfigParam.EPluginParamBehavior behavior,
                         String defaultValue)

Since:

version 4.3.0

Method Detail

getBehavior

public IPluginConfigParam.EPluginParamBehavior getBehavior()

Description copied from interface: IPluginConfigParam

Liefert das Aussage, wie der Parameter innerhalb der Pluginlogik interprertiert wird, also ob es sich um einen Input- oder Output-Parameter handelt.

Specified by:

getBehavior in interface IPluginConfigParam

Returns:

Enum vom Typ IPluginConfigParam.EPluginParamBehavior

setBehavior

public void setBehavior(IPluginConfigParam.EPluginParamBehavior paramBehavior)

hashCode

public int hashCode()

Overrides:

hashCode in class AConfigParam

equals

public boolean equals(Object obj)

Overrides:

equals in class AConfigParam

toString

public String toString()

Overrides:

toString in class AConfigParam