org.openemcee.microflow.usercore
Interface MicroflowParameters

All Known Implementing Classes:

KVParams

public interface MicroflowParameters

This interface provides access to parameters being passed to a Microflow entity (ex. Task, Validator, etc...)

Author:

Scott Schenkein

Field Summary

static java.lang.String

VCS_ID Version control info.

Method Summary

java.lang.String	getParameter(java.lang.String name) Retrieve a parameter of this name, if it is not set, this returns null.
java.lang.String	getParameter(java.lang.String name, java.lang.String defaultValue) Retrieve a parameter of this name, if it is not set, return a default value.
java.lang.String[]	getParameterNames() Retrieve a list of all the parameters available in this parameter bag.

Field Detail

VCS_ID

public static final java.lang.String VCS_ID

Version control info.

See Also:

Constant Field Values

Method Detail

getParameter

public java.lang.String getParameter(java.lang.String name)

Retrieve a parameter of this name, if it is not set, this returns null.

Parameters:

name - The name of the parameter to retrieve.

Returns:

Returns the value associated with the parameter, or null if not set.

getParameter

public java.lang.String getParameter(java.lang.String name,
                                     java.lang.String defaultValue)

Retrieve a parameter of this name, if it is not set, return a default value.

Parameters:

name - The name of the parameter to get.

defaultValue - The value to return of the parameter is not defined.

Returns:

Returns the value associated with the parameter, or the default value if not set.

getParameterNames

public java.lang.String[] getParameterNames()

Retrieve a list of all the parameters available in this parameter bag.

Returns:

An array of parameter names as strings.