com.flowable.serviceregistry.api.repository

Interface ServiceOutputParameter

All Superinterfaces:

ServiceParameter

All Known Implementing Classes:

BaseServiceOutputParameter

public interface ServiceOutputParameter
extends ServiceParameter

The interface of a service output parameter used in a service definition.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field and Description
static String	MISSING_VALUE_CONFIG_IGNORE Use this setting, if a missing output value should be ignored (left missing and not be overwritten with another value).
static String	MISSING_VALUE_CONFIG_SET_TO_DEFAULT Use this setting, if a missing output value should be set to a default value instead.
static String	MISSING_VALUE_CONFIG_SET_TO_NULL Use this setting, if a missing output value should be set to null instead.
static String	MISSING_VALUE_CONFIG_THROW_EXCEPTION Use this setting, if a missing output value should throw an exception.
static String	NULL_VALUE_CONFIG_REMOVE Use this setting, if an existing output value which is null should be removed from the result.
static String	NULL_VALUE_CONFIG_SET_TO_DEFAULT Use this setting, if an existing output value which is null should be set to a default value instead of null.
static String	NULL_VALUE_CONFIG_SET_TO_NULL Use this setting, if an existing output value which is null should be left as is.
static String	NULL_VALUE_CONFIG_THROW_EXCEPTION Use this setting, if an existing output value which is null should throw an exception.

Method Summary

Modifier and Type	Method and Description
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 getMissingValueConfig() is set to 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).
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 getNullValueConfig() is set to 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.

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

getDescription, getDisplayName, getMappingName, getName, getType

Field Detail

NULL_VALUE_CONFIG_REMOVE

static final String NULL_VALUE_CONFIG_REMOVE

Use this setting, if an existing output value which is null should be removed from the result.

See Also:

Constant Field Values

NULL_VALUE_CONFIG_SET_TO_DEFAULT

static final String NULL_VALUE_CONFIG_SET_TO_DEFAULT

Use this setting, if an existing output value which is null should be set to a default value instead of null.

See Also:

Constant Field Values

NULL_VALUE_CONFIG_SET_TO_NULL

static final String NULL_VALUE_CONFIG_SET_TO_NULL

Use this setting, if an existing output value which is null should be left as is.

See Also:

Constant Field Values

NULL_VALUE_CONFIG_THROW_EXCEPTION

static final String NULL_VALUE_CONFIG_THROW_EXCEPTION

Use this setting, if an existing output value which is null should throw an exception.

See Also:

Constant Field Values

MISSING_VALUE_CONFIG_IGNORE

static final String MISSING_VALUE_CONFIG_IGNORE

Use this setting, if a missing output value should be ignored (left missing and not be overwritten with another value).

See Also:

Constant Field Values

MISSING_VALUE_CONFIG_SET_TO_DEFAULT

static final String MISSING_VALUE_CONFIG_SET_TO_DEFAULT

Use this setting, if a missing output value should be set to a default value instead.

See Also:

Constant Field Values

MISSING_VALUE_CONFIG_SET_TO_NULL

static final String MISSING_VALUE_CONFIG_SET_TO_NULL

Use this setting, if a missing output value should be set to null instead.

See Also:

Constant Field Values

MISSING_VALUE_CONFIG_THROW_EXCEPTION

static final String MISSING_VALUE_CONFIG_THROW_EXCEPTION

Use this setting, if a missing output value should throw an exception.

See Also:

Constant Field Values

Method Detail

getPath

String getPath()

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

Returns:

the optional path for the result value

getNullValueConfig

String getNullValueConfig()

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).

Returns:

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

getMissingValueConfig

String getMissingValueConfig()

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).

Returns:

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

getNullValueDefault

String getNullValueDefault()

If the null value config returned by getNullValueConfig() is set to 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).

Returns:

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

getMissingValueDefault

String getMissingValueDefault()

If the null value config returned by getMissingValueConfig() is set to 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).

Returns:

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