ActionParameterRequestBuilder¶
-
public class
ActionParameterRequestBuilder
¶ The
ActionParameterRequestBuilder
class provides methods for constructing action parameter requests.See also:
org.motechproject.tasks.contract.ActionParameterRequest
Methods¶
createActionParameterRequest¶
-
public ActionParameterRequest
createActionParameterRequest
()¶ Builds an object of the
ActionParameterRequest
class.Returns: the created instance
setDisplayName¶
-
public ActionParameterRequestBuilder
setDisplayName
(String displayName)¶ Sets the display name of the action parameter to build the request for.
Parameters: - displayName – the action parameter display name
Returns: the reference to this object
setKey¶
-
public ActionParameterRequestBuilder
setKey
(String key)¶ Sets the key of the action parameter to build the request for.
Parameters: - key – the action parameter key
Returns: the reference to this object
setOptions¶
-
public ActionParameterRequestBuilder
setOptions
(SortedSet<String> options)¶ Sets the options of the action parameter to build the request for.
Parameters: - options – the action parameter options
Returns: the reference to this object
setOrder¶
-
public ActionParameterRequestBuilder
setOrder
(Integer order)¶ Sets the order of the action parameter to build the request for.
Parameters: - order – the action parameter order
Returns: the reference to this object
setRequired¶
-
public ActionParameterRequestBuilder
setRequired
(boolean required)¶ Defines whether the action parameter, that request will be build for, should be required.
Parameters: - required – defines if the action parameter should be required
Returns: the reference to this object
setType¶
-
public ActionParameterRequestBuilder
setType
(String type)¶ Sets the type of the action parameter to build the request for.
Parameters: - type – the action parameter type
Returns: the reference to this object
setValue¶
-
public ActionParameterRequestBuilder
setValue
(String value)¶ Sets the value of the action parameter to build the request for.
Parameters: - value – the action parameter value
Returns: the reference to this object