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

Class BaseServiceOutputParameter

java.lang.Object

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

com.flowable.serviceregistry.engine.impl.repository.BaseServiceOutputParameter

All Implemented Interfaces:

ServiceOutputParameter, ServiceParameter

public class BaseServiceOutputParameter
extends BaseServiceParameter
implements ServiceOutputParameter

Field Summary

Fields

Modifier and Type	Field	Description
protected String	applyMappingConfig
protected String	missingValueConfig
protected String	missingValueDefault
protected NestedOutputMapping	nestedOutputMapping
protected String	nullValueConfig
protected String	nullValueDefault
protected String	path
protected String	source

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

description, displayName, exampleData, mappingName, name, type, typeReference

Fields inherited from interface com.flowable.serviceregistry.api.repository.ServiceOutputParameter

APPLY_MAPPING_CONFIG_ALWAYS, APPLY_MAPPING_CONFIG_ERROR, APPLY_MAPPING_CONFIG_SUCCESS, MISSING_VALUE_CONFIG_IGNORE, MISSING_VALUE_CONFIG_SET_TO_DEFAULT, MISSING_VALUE_CONFIG_SET_TO_NULL, MISSING_VALUE_CONFIG_THROW_EXCEPTION, NULL_VALUE_CONFIG_REMOVE, NULL_VALUE_CONFIG_SET_TO_DEFAULT, NULL_VALUE_CONFIG_SET_TO_NULL, NULL_VALUE_CONFIG_THROW_EXCEPTION

Constructor Summary

Constructors

Constructor	Description
BaseServiceOutputParameter()

Method Summary

Modifier and Type	Method	Description
String	getApplyMappingConfig()	Retrieves the configuration that determines when to apply output parameter mapping.
String	getMissingValueConfig()	Returns the configuration on how to handle a missing value returned by the service invocation by this parameter.
String	getMissingValueDefault()	If the null value config returned by ServiceOutputParameter.getMissingValueConfig() is set to ServiceOutputParameter.MISSING_VALUE_CONFIG_SET_TO_DEFAULT, this method returns the default value to be returned instead of null (might be an expression or any value converted into the target parameter type).
NestedOutputMapping	getNestedOutputMapping()	Certain output parameters have a 'nested' definition (e.g.
String	getNullValueConfig()	Returns the configuration on how to handle a null value returned by the service invocation by this parameter.
String	getNullValueDefault()	If the null value config returned by ServiceOutputParameter.getNullValueConfig() is set to ServiceOutputParameter.NULL_VALUE_CONFIG_SET_TO_DEFAULT, this method returns the default value to be returned instead of null (might be an expression or any value converted into the target parameter type).
String	getPath()	Returns the optional path where the parameter value will be retrieved out of the returned service invocation result.
String	getSource()	Returns the optional source where the parameter value will be retrieved from of the returned service invocation result.
void	setApplyMappingConfig(String applyMappingConfig)
void	setMissingValueConfig(String missingValueConfig)
void	setMissingValueDefault(String missingValueDefault)
void	setNestedOutputMapping(NestedOutputMapping nestedOutputMapping)
void	setNullValueConfig(String nullValueConfig)
void	setNullValueDefault(String nullValueDefault)
void	setPath(String path)
void	setSource(String source)

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

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

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, getTypeReference

Field Details

path

protected String path

nullValueConfig

protected String nullValueConfig

missingValueConfig

protected String missingValueConfig

nullValueDefault

protected String nullValueDefault

missingValueDefault

protected String missingValueDefault

source

protected String source

applyMappingConfig

protected String applyMappingConfig

nestedOutputMapping

protected NestedOutputMapping nestedOutputMapping

Constructor Details

BaseServiceOutputParameter

public BaseServiceOutputParameter()

Method Details

getPath

public String getPath()

Description copied from interface: ServiceOutputParameter

Returns the optional path where the parameter value will be retrieved out of the returned service invocation result.

Specified by:

getPath in interface ServiceOutputParameter

Returns:

the optional path for the result value

setPath

public void setPath(String path)

getNullValueConfig

public String getNullValueConfig()

Description copied from interface: ServiceOutputParameter

Returns the configuration on how to handle a null value returned by the service invocation by this parameter. Might be 'remove', 'setToDefault', 'setToNull' or 'throwException' (see constant definition documentation for details).

Specified by:

getNullValueConfig in interface ServiceOutputParameter

Returns:

the configuration on how to handle a null value as the output for this parameter

setNullValueConfig

public void setNullValueConfig(String nullValueConfig)

getMissingValueConfig

public String getMissingValueConfig()

Description copied from interface: ServiceOutputParameter

Returns the configuration on how to handle a missing value returned by the service invocation by this parameter. Might be 'ignore', 'setToDefault', 'setToNull' or 'throwException' (see constant definition documentation for details).

Specified by:

getMissingValueConfig in interface ServiceOutputParameter

Returns:

the configuration on how to handle a missing value as the output for this parameter

setMissingValueConfig

public void setMissingValueConfig(String missingValueConfig)

getNullValueDefault

public String getNullValueDefault()

Description copied from interface: ServiceOutputParameter

If the null value config returned by ServiceOutputParameter.getNullValueConfig() is set to ServiceOutputParameter.NULL_VALUE_CONFIG_SET_TO_DEFAULT, this method returns the default value to be returned instead of null (might be an expression or any value converted into the target parameter type).

Specified by:

getNullValueDefault in interface ServiceOutputParameter

Returns:

the optional default value to be used if the null value config is actually set to default

setNullValueDefault

public void setNullValueDefault(String nullValueDefault)

getMissingValueDefault

public String getMissingValueDefault()

Description copied from interface: ServiceOutputParameter

If the null value config returned by ServiceOutputParameter.getMissingValueConfig() is set to ServiceOutputParameter.MISSING_VALUE_CONFIG_SET_TO_DEFAULT, this method returns the default value to be returned instead of null (might be an expression or any value converted into the target parameter type).

Specified by:

getMissingValueDefault in interface ServiceOutputParameter

Returns:

the optional default value to be used if the missing value config is actually set to default

setMissingValueDefault

public void setMissingValueDefault(String missingValueDefault)

getNestedOutputMapping

public NestedOutputMapping getNestedOutputMapping()

Description copied from interface: ServiceOutputParameter

Certain output parameters have a 'nested' definition (e.g. when a server returns nested json). The NestedOutputMapping contains this mapping of the nested data.

Specified by:

getNestedOutputMapping in interface ServiceOutputParameter

Returns:

the optional nested mapping.

setNestedOutputMapping

public void setNestedOutputMapping(NestedOutputMapping nestedOutputMapping)

getSource

public String getSource()

Description copied from interface: ServiceOutputParameter

Returns the optional source where the parameter value will be retrieved from of the returned service invocation result.

Specified by:

getSource in interface ServiceOutputParameter

Returns:

the optional path for the result value

setSource

public void setSource(String source)

getApplyMappingConfig

public String getApplyMappingConfig()

Description copied from interface: ServiceOutputParameter

Retrieves the configuration that determines when to apply output parameter mapping. The mapping can be applied under various conditions: Only for successful responses, only for error responses or always.

Specified by:

getApplyMappingConfig in interface ServiceOutputParameter

Returns:

The configuration for mapping application, which can be one of the following:

• ServiceOutputParameter.APPLY_MAPPING_CONFIG_ALWAYS - Mapping is always applied
• ServiceOutputParameter.APPLY_MAPPING_CONFIG_SUCCESS - Mapping is applied only for success responses
• ServiceOutputParameter.APPLY_MAPPING_CONFIG_ERROR - Mapping is applied only for error responses

setApplyMappingConfig

public void setApplyMappingConfig(String applyMappingConfig)