Package org.eclipse.emf.cdo.common.util

# Schnittstelle CDOQueryInfo

Alle bekannten Unterschnittstellen:
  `CDOQuery`

public interface CDOQueryInfo
Encapsulates all the transferable information that fully specifies a query from a `view` to a `repository`.

Seit:
  3.0
Autor:
  Simon McDuff
No Implement
  This interface is not intended to be implemented by clients.
No Extend
  This interface is not intended to be extended by clients.

## Feldübersicht

Felder
Modifizierer und Typ
Feld
Beschreibung
`static final String`
`PARAM_DISABLE_RESPONSE_FLUSHING`
The name of a `Boolean`-typed `parameter` to influence automatic response flushing (the default) after each query result.
`static final String`
`PARAM_DISABLE_RESPONSE_TIMEOUT`
The name of a `Boolean`-typed `parameter` that can suppress timeouts during slow query execution on the server.
`static final int`
`UNLIMITED_RESULTS`

## Methodenübersicht

Modifizierer und Typ
Methode
Beschreibung
`CDOChangeSetData`
`getChangeSetData()`
Returns the `change set` to be considered if this query has been created by a dirty transaction, `null` otherwise.
`Object`
`getContext()`
Returns the context object, or `null` if no context is bound.
`int`
`getMaxResults()`
Returns the maximum number of results to retrieve or `UNLIMITED_RESULTS` for no limitation.
`<T> T`
`getParameter(String name)`
Returns the value of the named parameter.
`Map<String,Object>`
`getParameters()`
Returns the parameters of this query as a map.
`String`
`getQueryLanguage()`
Returns the language identifier of this query, never `null`.
`String`
`getQueryString()`
Returns the query string of this query or `null` if no query string has been set.
`boolean`
`isLegacyModeEnabled()`
Veraltet.
As of 4.2 the legacy mode is always enabled.

## Felddetails

### UNLIMITED_RESULTS

static final int UNLIMITED_RESULTS

Siehe auch:
  - Konstantenfeldwerte

### PARAM_DISABLE_RESPONSE_FLUSHING

static final String PARAM_DISABLE_RESPONSE_FLUSHING
The name of a `Boolean`-typed `parameter` to influence automatic response flushing (the default) after each query result.

Seit:
  4.2
Siehe auch:
  - Konstantenfeldwerte

### PARAM_DISABLE_RESPONSE_TIMEOUT

static final String PARAM_DISABLE_RESPONSE_TIMEOUT
The name of a `Boolean`-typed `parameter` that can suppress timeouts during slow query execution on the server.

Seit:
  4.18
Siehe auch:
  - Konstantenfeldwerte

## Methodendetails

### getQueryLanguage

String getQueryLanguage()
Returns the language identifier of this query, never `null`.

### getQueryString

String getQueryString()
Returns the query string of this query or `null` if no query string has been set.

### getParameters

Map<String,Object> getParameters()
Returns the parameters of this query as a map.

### getParameter

<T> T getParameter(String name)
Returns the value of the named parameter.

Seit:
  4.6

### getContext

Object getContext()
Returns the context object, or `null` if no context is bound.

Seit:
  4.0

### getMaxResults

int getMaxResults()
Returns the maximum number of results to retrieve or `UNLIMITED_RESULTS` for no limitation.

### isLegacyModeEnabled

@Deprecated boolean isLegacyModeEnabled()
Veraltet.
As of 4.2 the legacy mode is always enabled.
Returns `true` if the view of this query had legacy mode enabled at the time this query was created, `false` otherwise.

Seit:
  4.0

### getChangeSetData

CDOChangeSetData getChangeSetData()
Returns the `change set` to be considered if this query has been created by a dirty transaction, `null` otherwise.

Seit:
  4.0