Interface ServiceInputParameter
-
- All Superinterfaces:
ServiceParameter
- All Known Implementing Classes:
BaseServiceInputParameter
public interface ServiceInputParameter extends ServiceParameter
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getBodyLocation()
Object
getDefaultValue()
boolean
isExcludedFromBody()
boolean
isQueryParameter()
When set to true, this parameter is appended to the URL as query parameter using theServiceParameter.getName()
as URL parameter name for REST Services.boolean
isRequired()
-
Methods inherited from interface com.flowable.serviceregistry.api.repository.ServiceParameter
getDescription, getDisplayName, getMappingName, getName, getType
-
-
-
-
Method Detail
-
isRequired
boolean isRequired()
-
isExcludedFromBody
boolean isExcludedFromBody()
-
isQueryParameter
boolean isQueryParameter()
When set to true, this parameter is appended to the URL as query parameter using theServiceParameter.getName()
as URL parameter name for REST Services.The
ServiceParameter.getMappingName()
can be used to decouple the query parameter name from the parameter name used in the models. Consider settingisExcludedFromBody()
totrue
, when the parameter is not required to be passed in the request body.- Returns:
true
in case this parameter should be added as URL query parameter.
-
getBodyLocation
String getBodyLocation()
-
getDefaultValue
Object getDefaultValue()
-
-