com.bowstreet.webapp
Interface DataService

All Superinterfaces:

IExemplar, WebAppObject

public interface DataService
extends WebAppObject

Data Service interface. A Data Service holds metadata about a common design pattern used by integration builders, involving one or more operations, where an operation has an arg-less method, and pulls inputs from WebApp Variable and puts results into another WebApp Variable.

Field Summary

Fields inherited from interface com.bowstreet.webapp.WebAppObject

ALWAYS_VISIBLE, INFORMATION_PROPERTY, NEVER_VISIBLE, SOMETIMES_VISIBLE

Method Summary

LogicalOperationDescriptor	addLogicalOperation(java.lang.String logicalName, java.lang.String operationName, java.lang.String keyRequired, java.lang.String keyProduced) Adds a new logical operation to the list
ServiceOperation	addOperation(java.lang.String name, java.lang.String executionMethodName) Adds ServiceOperation to WebApp.
LogicalOperationDescriptor	getLogicalOperation(java.lang.String logicalName) Get the LogicalOperationDescriptor about an function.
java.util.Iterator	getLogicalOperations() get an iterator to all the LogicalOperationDescriptor objects defined.
ServiceOperation	getOperation(java.lang.String name) Get ServiceOperation by name.
java.util.Iterator	getOperations() Get all the operations for this service.

Methods inherited from interface com.bowstreet.webapp.WebAppObject

clone, getBuilderCall, getName, getProperties, getProperty, getVisibility, isHidden, putProperty, setBuilderCall, setHidden, setName, setVisibility

Methods inherited from interface com.bowstreet.util.IExemplar

newInstance

Method Detail

addLogicalOperation

LogicalOperationDescriptor addLogicalOperation(java.lang.String logicalName,
                                               java.lang.String operationName,
                                               java.lang.String keyRequired,
                                               java.lang.String keyProduced)

Adds a new logical operation to the list

Parameters:

logicalName - Usually one of the LogicalOperationDescriptor.LOGICAL_OPERATION_ strings

operationName - the service operation name (req)

keyRequired - name that must be among this op's input values, or null

keyProduced - name that must be among this op's result values, or null

addOperation

ServiceOperation addOperation(java.lang.String name,
                              java.lang.String executionMethodName)

Adds ServiceOperation to WebApp.

Parameters:

name - Name of the operation.

executionMethodName - Name of the corresponding method for executing the operation.

Returns:

ServiceOperation

getLogicalOperation

LogicalOperationDescriptor getLogicalOperation(java.lang.String logicalName)

Get the LogicalOperationDescriptor about an function.

Parameters:

logicalName - Usually one of the LogicalOperationDescriptor.LOGICAL_OPERATION_ strings

Returns:

LogicalOperationDescriptor info concerning that function.

getLogicalOperations

java.util.Iterator getLogicalOperations()

get an iterator to all the LogicalOperationDescriptor objects defined.

Returns:

Iterator

getOperation

ServiceOperation getOperation(java.lang.String name)

Get ServiceOperation by name.

Parameters:

name - The name of the ServiceOperation.

Returns:

The ServiceOperation, or null if not present.

getOperations

java.util.Iterator getOperations()

Get all the operations for this service.

Returns:

collection of ServiceOperation