Package org.eclipse.emf.cdo.common.util
Interface CDOQueryInfo
-
- All Known Subinterfaces:
CDOQuery
public interface CDOQueryInfoEncapsulates all the transferable information that fully specifies a query from aviewto arepository.- 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 Summary
Fields Modifier and Type Field Description static java.lang.StringPARAM_DISABLE_RESPONSE_FLUSHINGThe name of aBooleantypedparameterto influence automatic response flushing (the default) after each query result.static intUNLIMITED_RESULTS
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description CDOChangeSetDatagetChangeSetData()Returns thechange setto be considered if this query has been created by a dirty transaction,nullotherwise.java.lang.ObjectgetContext()Returns the context object, ornullif no context is bound.intgetMaxResults()Returns the maximum number of results to retrieve orUNLIMITED_RESULTSfor no limitation.<T> TgetParameter(java.lang.String name)Returns the value of the named parameter.java.util.Map<java.lang.String,java.lang.Object>getParameters()Returns the parameters of this query as a map.java.lang.StringgetQueryLanguage()Returns the language identifier of this query, nevernull.java.lang.StringgetQueryString()Returns the query string of this query ornullif no query string has been set.booleanisLegacyModeEnabled()Deprecated.As of 4.2 the legacy mode is always enabled.
-
-
-
Field Detail
-
UNLIMITED_RESULTS
static final int UNLIMITED_RESULTS
- See Also:
- Constant Field Values
-
PARAM_DISABLE_RESPONSE_FLUSHING
static final java.lang.String PARAM_DISABLE_RESPONSE_FLUSHING
The name of aBooleantypedparameterto influence automatic response flushing (the default) after each query result.- Since:
- 4.2
- See Also:
- Constant Field Values
-
-
Method Detail
-
getQueryLanguage
java.lang.String getQueryLanguage()
Returns the language identifier of this query, nevernull.
-
getQueryString
java.lang.String getQueryString()
Returns the query string of this query ornullif no query string has been set.
-
getParameters
java.util.Map<java.lang.String,java.lang.Object> getParameters()
Returns the parameters of this query as a map.
-
getParameter
<T> T getParameter(java.lang.String name)
Returns the value of the named parameter.- Since:
- 4.6
-
getContext
java.lang.Object getContext()
Returns the context object, ornullif no context is bound.- Since:
- 4.0
-
getMaxResults
int getMaxResults()
Returns the maximum number of results to retrieve orUNLIMITED_RESULTSfor no limitation.
-
isLegacyModeEnabled
@Deprecated boolean isLegacyModeEnabled()
Deprecated.As of 4.2 the legacy mode is always enabled.Returnstrueif the view of this query had legacy mode enabled at the time this query was created,falseotherwise.- Since:
- 4.0
-
getChangeSetData
CDOChangeSetData getChangeSetData()
Returns thechange setto be considered if this query has been created by a dirty transaction,nullotherwise.- Since:
- 4.0
-
-