Package com.flowable.serviceregistry.engine.impl.repository

Class BaseServiceInputParameter

java.lang.Object

com.flowable.serviceregistry.engine.impl.repository.BaseServiceParameter

com.flowable.serviceregistry.engine.impl.repository.BaseServiceInputParameter

All Implemented Interfaces:

ServiceInputParameter, ServiceParameter

public class BaseServiceInputParameter
extends BaseServiceParameter
implements ServiceInputParameter

Field Summary

Fields

Modifier and Type	Field	Description
protected String	bodyLocation
protected Object	defaultValue
protected boolean	excludedFromBody
protected boolean	queryParameter
protected boolean	required

Fields inherited from class com.flowable.serviceregistry.engine.impl.repository.BaseServiceParameter

description, displayName, exampleData, mappingName, name, type

Constructor Summary

Constructors

Constructor	Description
BaseServiceInputParameter()

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()
void	setBodyLocation(String bodyLocation)
void	setDefaultValue(Object defaultValue)
void	setExcludedFromBody(boolean excludedFromBody)
void	setQueryParameter(boolean queryParameter)
void	setRequired(boolean required)

Methods inherited from class com.flowable.serviceregistry.engine.impl.repository.BaseServiceParameter

getDescription, getDisplayName, getExampleData, getMappingName, getName, getType, setDescription, setDisplayName, setExampleData, setMappingName, setName, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDescription, getDisplayName, getExampleData, getMappingName, getName, getType

Field Details

required

protected boolean required

excludedFromBody

protected boolean excludedFromBody

queryParameter

protected boolean queryParameter

bodyLocation

protected String bodyLocation

defaultValue

protected Object defaultValue

Constructor Details

BaseServiceInputParameter

public BaseServiceInputParameter()

Method Details

isRequired

public boolean isRequired()

Specified by:

isRequired in interface ServiceInputParameter

setRequired

public void setRequired(boolean required)

isExcludedFromBody

public boolean isExcludedFromBody()

Specified by:

isExcludedFromBody in interface ServiceInputParameter

setExcludedFromBody

public void setExcludedFromBody(boolean excludedFromBody)

isQueryParameter

public boolean isQueryParameter()

Description copied from interface: ServiceInputParameter

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 ServiceInputParameter.isExcludedFromBody() to true, when the parameter is not required to be passed in the request body.

Specified by:

isQueryParameter in interface ServiceInputParameter

Returns:

true in case this parameter should be added as URL query parameter.

setQueryParameter

public void setQueryParameter(boolean queryParameter)

getBodyLocation

public String getBodyLocation()

Specified by:

getBodyLocation in interface ServiceInputParameter

setBodyLocation

public void setBodyLocation(String bodyLocation)

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface ServiceInputParameter

setDefaultValue

public void setDefaultValue(Object defaultValue)