org.restsql.core

Interface SqlResource

public interface SqlResource

Represents an SQL Resource, a queryable and updatable database "view".

Author:

Mark Sawers

Method Summary

Methods

Modifier and Type	Method and Description
SqlResourceDefinition	getDefinition() Returns SQL resource information defined by the user, including query, validated attributes and trigger.
SqlResourceMetaData	getMetaData() Returns meta data for SQL resource.
String	getName() Returns SQL resource name.
List<Trigger>	getTriggers() Returns triggers classes.
List<Map<String,Object>>	read(Request request) Executes query returning results as an object collection.
String	read(Request request, String mediaType) Executes query returning results as a string.
WriteResponse	write(Request request) Executes database write (insert, update or delete).

Method Detail

getDefinition

SqlResourceDefinition getDefinition()

Returns SQL resource information defined by the user, including query, validated attributes and trigger.

Returns:

definition

getName

String getName()

Returns SQL resource name.

Returns:

SQL resource name

getMetaData

SqlResourceMetaData getMetaData()

Returns meta data for SQL resource.

Returns:

SQL rsource meta data

getTriggers

List<Trigger> getTriggers()

Returns triggers classes.

Returns:

list of trigger classes

read

List<Map<String,Object>> read(Request request)
                              throws SqlResourceException

Executes query returning results as an object collection.

Parameters:

request - Request object

Returns:

list of rows, where each row is a map of name-value pairs

Throws:

SqlResourceException - if a database access error occurs

read

String read(Request request,
          String mediaType)
            throws SqlResourceException

Executes query returning results as a string.

Parameters:

request - Request object

mediaType - response format, use internet media type e.g. application/xml

Returns:

list of rows, where each row is a map of name-value pairs

Throws:

SqlResourceException - if a database access error occurs

write

WriteResponse write(Request request)
                    throws SqlResourceException

Executes database write (insert, update or delete).

Parameters:

request - Request object

Returns:

write response

Throws:

SqlResourceException - if the request is invalid or a database access error or trigger exception occurs