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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ValueParameters()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Set<String>
getAttachmentsUuidSet()
String
getProcessParameter(String key)
List<String>
getProcessParameters(String key)
String
getProzessParam(String key)
Deprecated.When multiple values exists for a processing parameters, this returns all of them separated with a comma.Map<String,List<String>>
getProzessParameterMap()
String
getRenderParam(String key)
Deprecated.When multiple values exists for a render parameters, this returns all of them separated with a comma.String
getRenderParameter(String key)
Map<String,List<String>>
getRenderParameterMap()
List<String>
getRenderParameters(String key)
String
getSingelValue(String key)
Deprecated.String
getSingleValue(String key)
Map<String,List<String>>
getValuesMap()
void
setAttachmentsUuidSet(Set<String> attachmentsUuidSet)
Deprecated.void
setProzessParameterMap(Map<String,List<String>> prozessParameterMap)
void
setRenderParameter(String name, String value)
Sets the render parameter with the given name to a certain single value.void
setRenderParameterMap(Map<String,List<String>> renderParameterMap)
void
setValuesMap(Map<String,List<String>> valuesMap)
-
-
-
Method Detail
-
getValuesMap
public Map<String,List<String>> getValuesMap()
- Returns:
- A
Map
with all available request parameters. This includes thegetRenderParameterMap()
andgetProzessParameterMap()
.
-
getProzessParameterMap
public Map<String,List<String>> getProzessParameterMap()
- Returns:
- A
Map
with all available render parameters. Render parameters are parameters that start withCmnConst.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 withCmnConst.RenderParams.PREFIX
.
-
setRenderParameterMap
public void setRenderParameterMap(Map<String,List<String>> renderParameterMap)
-
setRenderParameter
public void setRenderParameter(String name, String value)
Sets the render parameter with the given name to a certain single value. Overrides any existing value for that name.- Parameters:
name
- The name of the render parameter.value
- The value of the render parameter.
-
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.
-
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. UsegetRenderParameter(String)
to get that value. Otherwise, if you expect multiple values, usegetRenderParameters(String)
.- Parameters:
key
- The key of a render parameter to retrieve. This key may or may not start with theCmnConst.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 withCmnConst.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 withCmnConst.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. UsegetProcessParameter(String)
to get that value. Otherwise, if you expect multiple values, usegetProcessParameters(String)
.- Parameters:
key
- The key of a process parameter to retrieve. This key may or may not start with theCmnConst.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. TheCmnConst.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. TheCmnConst.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.
-
-