Package de.xima.fc.mdl.request

Class ValueParameters

java.lang.Object
de.xima.fc.mdl.request.ValueParameters
All Implemented Interfaces:
Serializable
public class ValueParameters extends Object implements Serializable
Represents the parameters of form HTTP request as key-value pairs. They are grouped according to their type. For each key, there may exists multiple values. This class also provides some utility methods such as to get the first value for a certain key.
Author:
XIMA MEDIA GmbH
See Also:

  • Constructor Details

    • ValueParameters

      public ValueParameters()

  • Method Details

    • getValuesMap

      public Map<String,List<String>> getValuesMap()
      Returns:
      A Map with all available request parameters. This includes the getRenderParameterMap() and getProzessParameterMap().

    • setValuesMap

      public void setValuesMap(Map<String,List<String>> valuesMap)

    • getProzessParameterMap

      public Map<String,List<String>> getProzessParameterMap()
      Returns:
      A Map with all available render parameters. Render parameters are parameters that start with CmnConst.ProzessParams.PREFIX.

    • setProzessParameterMap

      public void setProzessParameterMap(Map<String,List<String>> prozessParameterMap)

    • getRenderParameterMap

      public Map<String,List<String>> getRenderParameterMap()
      Returns:
      A Map with all available render parameters. Render parameters are parameters that start with CmnConst.RenderParams.PREFIX.

    • setRenderParameterMap

      public void setRenderParameterMap(Map<String,List<String>> renderParameterMap)

    • getAttachmentsUuidSet

      public Set<String> getAttachmentsUuidSet()
      Returns:
      A set with all UUIDs of the attachments for the current FormEingang.

    • setAttachmentsUuidSet

      @Deprecated public void setAttachmentsUuidSet(Set<String> attachmentsUuidSet)
      Deprecated.

    • getSingleValue

      public String getSingleValue(String key)
      Parameters:
      key - The key of a request parameter to retrieve.
      Returns:
      All values for the given key, joined with a comma. When no value exists for the given key, returns the empty string.

    • getSingelValue

      @Deprecated public String getSingelValue(String key)
      Deprecated.
      Use getSingleValue(String)

    • getRenderParam

      @Deprecated public String getRenderParam(String key)
      Deprecated.
      When multiple values exists for a render parameters, this returns all of them separated with a comma. This usually occurs when the render parameter is specified twice (such as via URL and post parameters) -- in that case, it usually has the same value. Use getRenderParameter(String) to get that value. Otherwise, if you expect multiple values, use getRenderParameters(String).
      Parameters:
      key - The key of a render parameter to retrieve. This key may or may not start with the CmnConst.RenderParams.PREFIX.
      Returns:
      All values for the given key, separated with commas. When no value exists for the given key, returns the empty string.

    • getRenderParameters

      public List<String> getRenderParameters(String key)
      Parameters:
      key - The key of a render parameter to retrieve. When the key does not start with CmnConst.RenderParams.PREFIX, that prefix is added to the key.
      Returns:
      The first value for the given key. When no value exists for the given key, returns the empty list.

    • getRenderParameter

      public String getRenderParameter(String key)
      Parameters:
      key - The key of a render parameter to retrieve. When the key does not start with CmnConst.RenderParams.PREFIX, that prefix is added to the key.
      Returns:
      The first value for the given key. When no value exists for the given key, returns the empty string.

    • getProzessParam

      @Deprecated public String getProzessParam(String key)
      Deprecated.
      When multiple values exists for a processing parameters, this returns all of them separated with a comma. This usually occurs when the processing parameter is specified twice (as a URL parameter and as an input field) -- in that case, it usually has the same value. Use getProcessParameter(String) to get that value. Otherwise, if you expect multiple values, use getProcessParameters(String).
      Parameters:
      key - The key of a process parameter to retrieve. This key may or may not start with the CmnConst.ProzessParams.PREFIX.
      Returns:
      All values for the given key, separated with commas. When no value exists for the given key, returns the empty string.

    • getProcessParameters

      public List<String> getProcessParameters(String key)
      Parameters:
      key - The key of a process parameter to retrieve. The CmnConst.ProzessParams.PREFIX is added when the key does not have that prefix already.
      Returns:
      All values for the given processing parameters key. When no value exists for the given key, returns the empty list.

    • getProcessParameter

      public String getProcessParameter(String key)
      Parameters:
      key - The key of a process parameter to retrieve. The CmnConst.ProzessParams.PREFIX is added when the key does not have that prefix already.
      Returns:
      The first value for the given key. When no value exists for the given key, returns the empty string.