Package lumis.doui.service.api.rest.internal

Interface IDouiRestInterfaceRequest

public interface IDouiRestInterfaceRequest

A DOUI REST interface render request.

Since:

10.4.0

Version:

$Revision: 21230 $ $Date: 2018-04-24 19:07:57 -0300 (Tue, 24 Apr 2018) $

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IDouiRestInterfaceRequest.IOrderBy	Order by configuration.
static class	IDouiRestInterfaceRequest.OrderByDirection	Order by direction.
static class	IDouiRestInterfaceRequest.ResponseType	The response type.

Method Summary

Modifier and Type	Method	Description
List<String>	getFieldList()	Returns the requested field list.
Integer	getMaxRows()	Returns the requested maximum number of rows.
IDouiRestInterfaceRequest.IOrderBy	getOrderBy()	Returns the ordering.
HttpServletRequest	getRequest()	Returns the HTTP request.
IDouiRestInterfaceRequest.ResponseType	getResponseType()	Returns the response type.
String	getRestInterfaceId()	Returns the REST interface identifier.
ServiceInstanceConfig	getServiceInstance()	Returns the service instance.
SessionConfig	getSessionConfig()	Returns the user's session.
int	getStartAt()	Returns the start at configuration.
Map<String,String>	getUserParameters()	Returns the user parameters.

Method Detail

getFieldList

List<String> getFieldList()

Returns the requested field list.

Returns:

the requested field list.

Since:

10.4.0

getMaxRows

Integer getMaxRows()

Returns the requested maximum number of rows.

Returns:

the requested maximum number of rows.

Since:

10.4.0

getOrderBy

IDouiRestInterfaceRequest.IOrderBy getOrderBy()

Returns the ordering.

Returns:

the ordering.

Since:

10.4.0

getStartAt

int getStartAt()

Returns the start at configuration.

Returns:

the start at configuration.

Since:

10.4.0

getUserParameters

Map<String,String> getUserParameters()

Returns the user parameters.

Returns:

the user parameters.

Since:

10.4.0

getServiceInstance

ServiceInstanceConfig getServiceInstance()

Returns the service instance.

Returns:

the service instance.

Since:

10.4.0

getRestInterfaceId

String getRestInterfaceId()

Returns the REST interface identifier.

Returns:

the REST interface identifier.

Since:

10.4.0

getResponseType

IDouiRestInterfaceRequest.ResponseType getResponseType()

Returns the response type.

Returns:

the response type.

Since:

10.4.0

getSessionConfig

SessionConfig getSessionConfig()

Returns the user's session.

Returns:

the user's session.

Since:

10.4.0

getRequest

HttpServletRequest getRequest()

Returns the HTTP request.

Returns:

the HTTP request.

Since:

10.4.0