Package com.flowable.serviceregistry.api.repository

Interface ServiceInputParameter

All Superinterfaces:

ServiceParameter

All Known Implementing Classes:

BaseServiceInputParameter

public interface ServiceInputParameter
extends ServiceParameter

Method Summary

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 the ServiceParameter.getName() as URL parameter name for REST Services.
boolean	isRequired()

Methods inherited from interface com.flowable.serviceregistry.api.repository.ServiceParameter

getDescription, getDisplayName, getExampleData, getMappingName, getName, getType, getTypeReference

Method Details

isRequired

boolean isRequired()

isExcludedFromBody

boolean isExcludedFromBody()

isQueryParameter

boolean isQueryParameter()

When set to true, this parameter is appended to the URL as query parameter using the ServiceParameter.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 setting isExcludedFromBody() to true, 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()