com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest Interface Reference

Inheritance diagram for com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest:

List of all members.

Public Member Functions
ResultType	getResultType ()
void	setResultType (ResultType resultType)
IRetrievalSchema	getRetrievalSchema ()
void	setRetrievalSchema (IRetrievalSchema retrievalSchema)
boolean	shouldRetrieveCount ()
void	setRetrieveCount (boolean shouldRetrieveCount)
void	setParameters (IParameterMap parameterMap)
IParameterMap	createParameterMap ()
IParameterMap	getParameters ()
int	getQueryTimeout ()
void	setQueryTimeout (int queryTimeout)
boolean	isSecurityDisabled ()
void	setSecurityDisabled (boolean securityDisabled)
void	setAccessRightsToRetrieve (int...accessRights)
int	getAccessRightsToRetrieve ()
boolean	mustRetrieveAccessRight (int accessRight)
boolean	mustRetrieveAllAccessRights ()
boolean	doNotRestrictResultsBySecurity ()
void	setDoNotRestrictResultsBySecurity (boolean doNotRestrictResultsBySecurity)
boolean	mustRetrieveOnlyRights ()
void	setRetrieveOnlyRights (boolean retrieveOnlyRights)
String	getDataStoreIdentifier ()
void	setDataStoreIdentifier (String identifier)
IOQLGetRequest	getSuitableRequest (IContext context) throws ConnectionBusException
Element	toXML (Document xmlDoc)
String	toTraceString ()
Static Public Attributes
static final int	READ_ACCESS = 1
static final int	WRITE_ACCESS = 2
static final int	CREATE_ACCESS = 4
static final int	DELETE_ACCESS = 8
static final int	FULL_ACCESS = READ_ACCESS | WRITE_ACCESS | CREATE_ACCESS | DELETE_ACCESS

---

Detailed Description

This interface represents a retrieval request. All implementations of this interface can be used to define different manners to retrieve data.

---

Member Function Documentation

IParameterMap com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.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

boolean com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.doNotRestrictResultsBySecurity

(

)

Only for internal use.

Returns:

int com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.getAccessRightsToRetrieve

(

)

String com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.getDataStoreIdentifier

(

)

Returns:

IParameterMap com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.getParameters

(

)

Returns the object with parameters values.

Returns:

int com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.getQueryTimeout

(

)

Returns the execution timeout of all the queries executed for this request.

Returns:

the query execution timeout.

ResultType com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.getResultType

(

)

Returns the type of the result (raw or entity) of this request.

IRetrievalSchema com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.getRetrievalSchema

(

)

Returns the format of the data to be retrieved.

IOQLGetRequest com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.getSuitableRequest

(

IContext

context

)

throws ConnectionBusException

Only for internal use.

Parameters:

context

Exceptions:

ConnectionBusException

boolean com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.isSecurityDisabled

(

)

Specifies whether the security must be checked when the query is executed or not.

Returns:

whether the security must be checked when the query is executed or not

boolean com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.mustRetrieveAccessRight

(

int

accessRight

)

Only for internal use.

Parameters:

accessRight

One of the following fields: READ_ACCESS, WRITE_ACCESS, CREATE_ACCESS, DELETE_ACCESS.

Returns:

boolean com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.mustRetrieveAllAccessRights

(

)

boolean com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.mustRetrieveOnlyRights

(

)

Only for internal use.

Returns:

void com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.setAccessRightsToRetrieve

(

int...

accessRights

)

Only for internal use.

Parameters:

accessRights

One or more of the following fields: READ_ACCESS, WRITE_ACCESS, CREATE_ACCESS, DELETE_ACCESS.

void com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.setDataStoreIdentifier

(

String

identifier

)

Only for internal use.

Parameters:

identifier

void com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.setDoNotRestrictResultsBySecurity

(

boolean

doNotRestrictResultsBySecurity

)

Only for internal use.

Parameters:

doNotRestrictResultsBySecurity

void com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.setParameters

(

IParameterMap

parameterMap

)

Specifies the parameter values of the query.

Parameters:

parameterMap

the parameter values of the query

void com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.setQueryTimeout

(

int

queryTimeout

)

Sets the execution timeout of all the queries executed for this request.

Parameters:

queryTimeout

the execution timeout in seconds

void com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.setResultType

(

ResultType

resultType

)

Sets the type of the result (raw or entity) of this request.

void com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.setRetrievalSchema

(

IRetrievalSchema

retrievalSchema

)

Sets the format of the data to be retrieved.

void com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.setRetrieveCount

(

boolean

shouldRetrieveCount

)

Sets whether this request retrieves also the count of the rows, when there isn't set a result limit.

Parameters:

shouldRetrieveCount

this defines whether this request retrieves also the count of the rows.

void com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.setRetrieveOnlyRights

(

boolean

retrieveOnlyRights

)

Only for internal use.

Parameters:

retrieveOnlyRights

void com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.setSecurityDisabled

(

boolean

securityDisabled

)

Sets whether the security must be checked when the query is executed or not.

Parameters:

securityDisabled

true if the security must be checked when the query is executed

boolean com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.shouldRetrieveCount

(

)

Returns whether this request retrieves also the count of the rows, when there isn't set a result limit.

Returns:

whether this request retrieves also the count of the rows.

String com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.toTraceString

(

)

Only for internal use.

Element com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.toXML

(

Document

xmlDoc

)

Only for internal use.

Parameters:

xmlDoc

---

Member Data Documentation

final int com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.CREATE_ACCESS = 4 [static]

final int com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.DELETE_ACCESS = 8 [static]

final int com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.FULL_ACCESS = READ_ACCESS | WRITE_ACCESS | CREATE_ACCESS | DELETE_ACCESS [static]

final int com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.READ_ACCESS = 1 [static]

final int com.mendix.systemwideinterfaces.connectionbus.requests.types.IGetRequest.WRITE_ACCESS = 2 [static]

---

The documentation for this interface was generated from the following file:

• IGetRequest.java