org.diirt.service.jdbc

Class JDBCServiceMethodDescription

java.lang.Object

org.diirt.service.ServiceMethodDescription

org.diirt.service.jdbc.JDBCServiceMethodDescription

public class JDBCServiceMethodDescription
extends ServiceMethodDescription

The description for a JDBC service method (i.e. a query).

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
JDBCServiceMethodDescription(String name, String description) A new service method with the given name and description.

Method Summary

Modifier and Type	Method and Description
ServiceMethod	createServiceMethod(ServiceDescription serviceDescription) Creates a service method with the given description.
JDBCServiceMethodDescription	query(String query) The query mapped to this service method; cannot have multiple query commands.
JDBCServiceMethodDescription	queryResult(String name, String description) Adds a result for the query.

Methods inherited from class org.diirt.service.ServiceMethodDescription

addArgument, addResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JDBCServiceMethodDescription

public JDBCServiceMethodDescription(String name,
                                    String description)

A new service method with the given name and description.

Parameters:

name - the method name; can't be null

description - the method description; can't be null

Method Detail

queryResult

public JDBCServiceMethodDescription queryResult(String name,
                                                String description)

Adds a result for the query.

The result must be specified if the query returns data (i.e. it is a SELECT) and must not be specified if the query does not return data (i.e. INSERT, UPDATE, DELETE, ...).

Parameters:

name - the result name; can't be null

description - the result description; can't be null

Returns:

this

query

public JDBCServiceMethodDescription query(String query)

The query mapped to this service method; cannot have multiple query commands.

Parameters:

query - the query to execute; can't be null

Returns:

this

createServiceMethod

public ServiceMethod createServiceMethod(ServiceDescription serviceDescription)

Description copied from class: ServiceMethodDescription

Creates a service method with the given description.

A client should implement this to return their service method implementation.

Specified by:

createServiceMethod in class ServiceMethodDescription

Parameters:

serviceDescription - service description for the new service method

Returns:

a new service method