org.restsql.core

Interface Request

public interface Request

Represents a single CRUD request on a specific SQL Resource.

Author:

Mark Sawers

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Request.Type Represents request types, mapping to CRUD operations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_NAME_LIMIT
static String	PARAM_NAME_OFFSET
static String	PARAM_NAME_OUTPUT

Method Summary

Methods

Modifier and Type	Method and Description
void	extractParameters() Extract limit and offset.
List<List<RequestValue>>	getChildrenParameters() Returns children CUD requests to a single parent for a hierarchical SQL Resource.
HttpRequestAttributes	getHttpRequestAttributes() Returns http request attributes.
RequestLogger	getLogger() Returns request logger.
List<RequestValue>	getParameters() Returns ordered list of parameters, for example the selection filter for update request.
Request	getParent() Returns parent, if any.
List<RequestValue>	getResourceIdentifiers() Returns ordered list of primary key values for a CRUD request on a single object (row).
Integer	getSelectLimit() Returns select row limit, if any.
Integer	getSelectOffset() Returns select row offset, if any.
String	getSqlResource() Returns SQL Resource name.
Request.Type	getType() Returns request type.
boolean	hasParameter(String name) Returns true if request has parameter with the given name.
void	setParameters(List<RequestValue> params) Sets parameters for request.
void	setParent(Request parentRequest) Sets parent request.
void	setSelectLimit(Integer integer) Sets select limit.
void	setSelectOffset(Integer integer) Sets select offset.

Field Detail

PARAM_NAME_LIMIT

static final String PARAM_NAME_LIMIT

See Also:

Constant Field Values

PARAM_NAME_OFFSET

static final String PARAM_NAME_OFFSET

See Also:

Constant Field Values

PARAM_NAME_OUTPUT

static final String PARAM_NAME_OUTPUT

See Also:

Constant Field Values

Method Detail

getChildrenParameters

List<List<RequestValue>> getChildrenParameters()

Returns children CUD requests to a single parent for a hierarchical SQL Resource.

getHttpRequestAttributes

HttpRequestAttributes getHttpRequestAttributes()

Returns http request attributes.

getLogger

RequestLogger getLogger()

Returns request logger.

getParameters

List<RequestValue> getParameters()

Returns ordered list of parameters, for example the selection filter for update request.

getParent

Request getParent()

Returns parent, if any.

getResourceIdentifiers

List<RequestValue> getResourceIdentifiers()

Returns ordered list of primary key values for a CRUD request on a single object (row). On a hierarchical SQL Resource, this list identifies the parent and the children are identified by the children parameters.

getSelectLimit

Integer getSelectLimit()

Returns select row limit, if any.

getSelectOffset

Integer getSelectOffset()

Returns select row offset, if any.

getSqlResource

String getSqlResource()

Returns SQL Resource name.

getType

Request.Type getType()

Returns request type.

hasParameter

boolean hasParameter(String name)

Returns true if request has parameter with the given name.

setParameters

void setParameters(List<RequestValue> params)

Sets parameters for request. Used for cloning requests on child objects.

setParent

void setParent(Request parentRequest)

Sets parent request.

setSelectLimit

void setSelectLimit(Integer integer)

Sets select limit.

setSelectOffset

void setSelectOffset(Integer integer)

Sets select offset.

extractParameters

void extractParameters()
                       throws InvalidRequestException

Extract limit and offset.

Throws:

InvalidRequestException - if request is invalid