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	Description
`static java.lang.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 java.lang.String`	`MISSING_VALUE_CONFIG_SET_TO_DEFAULT`	Use this setting, if a missing output value should be set to a default value instead.
`static java.lang.String`	`MISSING_VALUE_CONFIG_SET_TO_NULL`	Use this setting, if a missing output value should be set to null instead.
`static java.lang.String`	`MISSING_VALUE_CONFIG_THROW_EXCEPTION`	Use this setting, if a missing output value should throw an exception.
`static java.lang.String`	`NULL_VALUE_CONFIG_REMOVE`	Use this setting, if an existing output value which is null should be removed from the result.
`static java.lang.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 java.lang.String`	`NULL_VALUE_CONFIG_SET_TO_NULL`	Use this setting, if an existing output value which is null should be left as is.
`static java.lang.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	Description
`java.lang.String`	`getMissingValueConfig()`	Returns the configuration on how to handle a missing value returned by the service invocation by this parameter.
`java.lang.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).
`java.lang.String`	`getNullValueConfig()`	Returns the configuration on how to handle a null value returned by the service invocation by this parameter.
`java.lang.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).
`java.lang.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 Details
- NULL_VALUE_CONFIG_REMOVE
  
  static final java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String MISSING_VALUE_CONFIG_THROW_EXCEPTION
  
  Use this setting, if a missing output value should throw an exception.
  
  See Also:
  
  Constant Field Values
Method Details
- getPath
  
  java.lang.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
  
  java.lang.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
  
  java.lang.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
  
  java.lang.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
  
  java.lang.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

Interface ServiceOutputParameter

Field Summary

Method Summary

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

Field Details

Method Details