Package com.priint.pubserver.metadata.xml.placeholder

Class FunctionVariableImpl

java.lang.Object
com.priint.pubserver.metadata.xml.placeholder.FunctionVariableImpl
All Implemented Interfaces:
FunctionVariable, Serializable
public class FunctionVariableImpl extends Object implements FunctionVariable, Serializable
See Also:

  • Constructor Details

    • FunctionVariableImpl

      public FunctionVariableImpl()

  • Method Details

    • getKey

      public String getKey()
      Description copied from interface: FunctionVariable

      Gets the key of this function variable

      Specified by:
      getKey in interface FunctionVariable
      Returns:
      the key

    • setKey

      public void setKey(String key)
      Description copied from interface: FunctionVariable

      Sets the key of this function variable

      Specified by:
      setKey in interface FunctionVariable
      Parameters:
      key - the key to set

    • getLabel

      public String getLabel()
      Description copied from interface: FunctionVariable

      Gets the label of this function variable

      Purpose of the label is e.g. show in UI. The label is not necessarily unique, this means: function variables should be referred by the key rather than the label.

      Specified by:
      getLabel in interface FunctionVariable
      Returns:
      the label

    • setLabel

      public void setLabel(String label)
      Description copied from interface: FunctionVariable

      Sets the label of the function variable

      Specified by:
      setLabel in interface FunctionVariable
      Parameters:
      label - the label to set

    • getSelectedKey

      public String getSelectedKey()
      Description copied from interface: FunctionVariable

      Gets the key of the selected function variable value

      Gets the key of the function variable value, which is selected for this particular placeholder.

      Usually, the selected key is one of the keys defined in the values list for this function variable. If key is empty or null, the default key (i.e. first entry in the list of values) should be used, unless a custom value has been set, in which case FunctionVariable.getCustom() returns a value other than empty or null.

      Specified by:
      getSelectedKey in interface FunctionVariable
      Returns:
      the selectedKey

    • setSelectedKey

      public void setSelectedKey(String selectedKey)
      Description copied from interface: FunctionVariable

      Sets the key of the selected function variable value

      Sets the key of the function variable value, which is selected for this particular placeholder

      To use the default value (i.e. first entry in the list of values) or use the value returned by FunctionVariable.getCustom(), selected key must be set to empty string or null.

      Specified by:
      setSelectedKey in interface FunctionVariable
      Parameters:
      selectedKey - the selectedKey to set

    • getCustom

      public String getCustom()
      Description copied from interface: FunctionVariable

      Gets the custom value assigned to this function variable

      Gets the custom value assgined to this function variable, if a custom value has been applied, otherwise returns an empty string or null

      Specified by:
      getCustom in interface FunctionVariable
      Returns:
      the custom

    • setCustom

      public void setCustom(String custom)
      Description copied from interface: FunctionVariable

      Sets the custom value of this function variable

      Sets the custom value of this function variable, if a custom value should be applied. Empty string or null means to use the default value or value defined by FunctionVariable.getSelectedKey() key.

      Specified by:
      setCustom in interface FunctionVariable
      Parameters:
      custom - the custom to set

    • getDefinedBy

      public PlaceholderAction getDefinedBy()
      Description copied from interface: FunctionVariable

      Gets the domain of this function variable

      Gets the domain of this function variable. Function variables can be defined either by the PlaceholderAction.LOAD, PlaceholderAction.SYNC or PlaceholderAction.STORE action.

      Specified by:
      getDefinedBy in interface FunctionVariable
      Returns:
      the definedBy

    • setDefinedBy

      public void setDefinedBy(PlaceholderAction definedBy)
      Description copied from interface: FunctionVariable

      Sets the function variable domain

      Sets the domain of this function variable. Function variables can be defined either by the PlaceholderAction.LOAD, PlaceholderAction.SYNC or PlaceholderAction.STORE action.

      Specified by:
      setDefinedBy in interface FunctionVariable
      Parameters:
      definedBy - the definedBy to set

    • getValues

      public List<KeyLabel> getValues()
      Description copied from interface: FunctionVariable

      Gets the key label pairs, which are applicable for this function variable

      Usually, one of these values is selected for this function variables via a proper FunctionVariable.getSelectedKey() value, which refers to the key of one of the entries in the values list.

      Specified by:
      getValues in interface FunctionVariable
      Returns:
      the values

    • setValues

      public void setValues(List<KeyLabel> values)
      Description copied from interface: FunctionVariable

      Sets the key value pairs, which are applicable for this function variable

      Specified by:
      setValues in interface FunctionVariable
      Parameters:
      values - the values to set