com.esri.arcgis.geodatabase
Interface IQueryDescription

All Superinterfaces:
Serializable
All Known Implementing Classes:
IQueryDescriptionProxy

public interface IQueryDescription
extends Serializable

Query information

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 IFields getFields()
          The resultset fields.
 int getGeometryType()
          Geometry type on the spatial column if present.
 String getOIDColumnName()
          Name of OID field.
 String getOIDFields()
          Unique key field(s).
 String getQuery()
          Query statemaent.
 String getShapeColumnName()
          Geometry column if present.
 ISpatialReference getSpatialReference()
          Spatial reference.
 String getSrid()
          Srid of the resultset.
 boolean isOIDMappedColumn()
          Indicates if a virtual OID column is required.
 boolean isSpatialQuery()
          Indicates if the query resultset is spatial.
 void setGeometryType(int pGeomType)
          Geometry type on the spatial column if present.
 void setOIDFields(String ppOidMap)
          Unique key field(s).
 void setSpatialReference(ISpatialReference ppSpatialReference)
          Spatial reference.
 void setSrid(String pSrid)
          Srid of the resultset.
 

Method Detail

setSrid

void setSrid(String pSrid)
             throws IOException,
                    AutomationException
Srid of the resultset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pSrid - The pSrid (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSrid

String getSrid()
               throws IOException,
                      AutomationException
Srid of the resultset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pSrid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReference

void setSpatialReference(ISpatialReference ppSpatialReference)
                         throws IOException,
                                AutomationException
Spatial reference.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException
Spatial reference.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOIDFields

void setOIDFields(String ppOidMap)
                  throws IOException,
                         AutomationException
Unique key field(s).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppOidMap - The ppOidMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOIDFields

String getOIDFields()
                    throws IOException,
                           AutomationException
Unique key field(s).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The ppOidMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeometryType

void setGeometryType(int pGeomType)
                     throws IOException,
                            AutomationException
Geometry type on the spatial column if present.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pGeomType - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometryType

int getGeometryType()
                    throws IOException,
                           AutomationException
Geometry type on the spatial column if present.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShapeColumnName

String getShapeColumnName()
                          throws IOException,
                                 AutomationException
Geometry column if present.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pShapeColumnName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOIDColumnName

String getOIDColumnName()
                        throws IOException,
                               AutomationException
Name of OID field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pOIDColumnName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

IFields getFields()
                  throws IOException,
                         AutomationException
The resultset fields.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getQuery

String getQuery()
                throws IOException,
                       AutomationException
Query statemaent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pQuery
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOIDMappedColumn

boolean isOIDMappedColumn()
                          throws IOException,
                                 AutomationException
Indicates if a virtual OID column is required.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pIsOIDMappedColumn
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSpatialQuery

boolean isSpatialQuery()
                       throws IOException,
                              AutomationException
Indicates if the query resultset is spatial.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pIsSpatialQuery
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.