com.bowstreet.webapp
Interface ServiceOperation

public interface ServiceOperation

Holds metadata about a single operation in a DataService.

Method Summary

ServiceParameter	addParameter(java.lang.String name, java.lang.String variableName, int direction) Adds a new ServiceParameter.
java.lang.String	getDescription() Get description of this operation
java.lang.String	getExecutionMethodName() Get name of WebApp method for executing this operation.
java.lang.String	getName() Get logical name of this operation.
ServiceParameter	getParameter(java.lang.String name) Get a ServiceParameter by name
java.util.Iterator	getParameters() Get list of ServiceParameter objects.
java.util.Iterator	getProperties() Gets an iterator to the keys of the properties.
java.lang.Object	getProperty(java.lang.String key) Gets a property given the key.
boolean	isStateful() Returns true if the ServiceOperation is stateful, false if it is stateless
void	putProperty(java.lang.String key, java.lang.Object value) Sets the specified property.
void	setDescription(java.lang.String description) Set description of this operation
void	setExecutionMethodName(java.lang.String executionMethodName)
void	setName(java.lang.String name)
void	setStateful(boolean isStateful) Sets the stateful flag for the ServiceOperation

Method Detail

addParameter

ServiceParameter addParameter(java.lang.String name,
                              java.lang.String variableName,
                              int direction)

Adds a new ServiceParameter.

Parameters:

name - Logical name of parameter.

variableName - The name of the associated WebApp variable.

direction - - ServiceParameter.INPUT, OUTPUT, IN_OUT

Returns:

The new ServiceParameter object.

getDescription

java.lang.String getDescription()

Get description of this operation

Returns:

the description

getExecutionMethodName

java.lang.String getExecutionMethodName()

Get name of WebApp method for executing this operation.

Returns:

name of WebApp method for executing this operation

getName

java.lang.String getName()

Get logical name of this operation.

Returns:

the name

getParameter

ServiceParameter getParameter(java.lang.String name)

Get a ServiceParameter by name

getParameters

java.util.Iterator getParameters()

Get list of ServiceParameter objects.

Returns:

iterator to list of ServiceParameter objects

getProperties

java.util.Iterator getProperties()

Gets an iterator to the keys of the properties.

Returns:

Iterator of property keys.

getProperty

java.lang.Object getProperty(java.lang.String key)

Gets a property given the key.

Returns:

The value of the specified property.

isStateful

boolean isStateful()

Returns true if the ServiceOperation is stateful, false if it is stateless

Returns:

true if the ServiceOperation is stateful, false if it is stateless

putProperty

void putProperty(java.lang.String key,
                 java.lang.Object value)

Sets the specified property.

setDescription

void setDescription(java.lang.String description)

Set description of this operation

Parameters:

description - The description to set

setExecutionMethodName

void setExecutionMethodName(java.lang.String executionMethodName)

Parameters:

executionMethodName - The name of WebApp execution method for executing the operation.

setName

void setName(java.lang.String name)

Parameters:

name - The name to set.

setStateful

void setStateful(boolean isStateful)

Sets the stateful flag for the ServiceOperation

Parameters:

isStateful - the value of the stateful flag