Package com.mendix.systemwideinterfaces.connectionbus.requests.types

Interface ITextGetRequest

All Superinterfaces:

IGetRequest

All Known Subinterfaces:

IOQLTextGetRequest, IXPathTextGetRequest

public interface ITextGetRequest
extends IGetRequest

This interface represents a textual retrieval request. Implementations of this interface contain a textual retrieval text which will be parsed to determine which objects must be retrieved.

Method Summary

Modifier and Type	Method	Description
IParameterMap	createParameterMap()	Returns a new object to set parameter values for this query.
IParameterMap	getParameters()	Returns the object with parameters values.
String	getQuery()	Returns the retrieval text of this request.
void	setParameters(IParameterMap parameterMap)	Specifies the parameter values of the query.
void	setQuery(String query)	Sets the retrieval text of this request.

Methods inherited from interface com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest

getQueryTimeout, getRetrievalSchema, setQueryTimeout, setRetrievalSchema, setRetrieveCount, shouldRetrieveCount

Method Details

getQuery

String getQuery()

Returns the retrieval text of this request.

setQuery

void setQuery(String query)

Sets the retrieval text of this request.

Parameters:

query - the query to execute for the request

setParameters

void setParameters(IParameterMap parameterMap)

Specifies the parameter values of the query.

Parameters:

parameterMap - the parameter values of the query

createParameterMap

IParameterMap createParameterMap()

Returns a new object to set parameter values for this query. This object must be set for the request by the method setParameters(..).

Returns:

a new object to set parameter values for this query

getParameters

IParameterMap getParameters()

Returns the object with parameters values.

Returns:

the parameter values of the query