com.bowstreet.webapp
Interface ServiceParameter

public interface ServiceParameter

Holds metadata about a single parameter to a ServiceOperation (part of a DataService object).

Field Summary

static int	IN_OUT Value for direction (input/output).
static int	INPUT Value for direction (input).
static int	OUTPUT Value for direction (output).

Method Summary

java.lang.String	getDescription(java.lang.String paramElement) Get description of the parameter.
java.util.Map	getDescriptionsMap() Retrieves all description elements for this paramter.
int	getDirection() Get direction (INPUT, OUTPUT, IN_OUT)
java.lang.String	getName() Logical name of parameter
java.lang.String	getVariableName() Get name of WebApp variable that holds this parameter
void	setDescription(java.lang.String paramElement, java.lang.String description) Sets the description for the parameter or its element (for complex parameters).
void	setDirection(int direction)
void	setName(java.lang.String name)
void	setVariableName(java.lang.String variableName)

Field Detail

IN_OUT

static final int IN_OUT

Value for direction (input/output).

See Also:

Constant Field Values

INPUT

static final int INPUT

Value for direction (input).

See Also:

Constant Field Values

OUTPUT

static final int OUTPUT

Value for direction (output).

See Also:

Constant Field Values

Method Detail

getDescription

java.lang.String getDescription(java.lang.String paramElement)

Get description of the parameter.

Parameters:

paramElement - the path of the parameter element for the complex type, e.g., if parameter is a complex variable named address with leaves name and phone then paramElement can be address/name and address/phone. The paramElement can be null.

Returns:

description for the given paramElement.

getDescriptionsMap

java.util.Map getDescriptionsMap()

Retrieves all description elements for this paramter. For simple paramters there is almost always only one description when for complex (schema typed) ones there could be multiple descritions for different leaf nodes of the same complex parameter.

getDirection

int getDirection()

Get direction (INPUT, OUTPUT, IN_OUT)

Returns:

one of (INPUT, OUTPUT, IN_OUT)

getName

java.lang.String getName()

Logical name of parameter

Returns:

the name

getVariableName

java.lang.String getVariableName()

Get name of WebApp variable that holds this parameter

Returns:

The variable name.

setDescription

void setDescription(java.lang.String paramElement,
                    java.lang.String description)

Sets the description for the parameter or its element (for complex parameters). If parameter is a complex variable named address with leaves name and phone then paramElement can be address/name and address/phone. The paramElement can be null.

setDirection

void setDirection(int direction)

Parameters:

direction - The direction to set (INPUT, OUTPUT, IN_OUT).

setName

void setName(java.lang.String name)

Parameters:

name - The loginal name to set.

setVariableName

void setVariableName(java.lang.String variableName)

Parameters:

variableName - The variableName to set.