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

Interface CDOQueryInfo

All Known Subinterfaces:
CDOQuery
public interface CDOQueryInfo
Encapsulates all the transferable information that fully specifies a query from a view to a repository.
Since:
3.0
Author:
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.

  • Field Details

    • UNLIMITED_RESULTS

      static final int UNLIMITED_RESULTS
      See Also:

    • 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.
      Since:
      4.2
      See Also:

    • 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.
      Since:
      4.18
      See Also:

  • Method Details

    • 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.
      Since:
      4.6

    • getContext

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

    • getMaxResults

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

    • isLegacyModeEnabled

      @Deprecated boolean isLegacyModeEnabled()
      Deprecated.
      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.
      Since:
      4.0

    • getChangeSetData

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