com.esri.arcgis.schematic
Interface INgAttributeQuery

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgAttributeQueryProxy, NgAttributeQuery

public interface INgAttributeQuery
extends Serializable

Provides access to members that control the attribute query.

Description

An attribute query is an attribute which values are stored in a field that is returned by a query other than that associated with the object type the attribute applies.

Product Availability

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

See Also:
INgAttribute

Method Summary
 INgDataSource getDataSource()
          Data source used by the query.
 String getFieldName()
          Name of the field related to the attribute query.
 String getName()
          Name of the attribute query.
 INgParameters getParameters()
          List of the parameters used by the query.
 String getQueryString()
          Query, name of the query, or name of the table that returnes the field associated with the attribute query.
 void setDataSource(INgDataSource pVal)
          Data source used by the query.
 void setFieldName(String pVal)
          Name of the field related to the attribute query.
 void setName(String pVal)
          Name of the attribute query.
 void setParameters(INgParameters pVal)
          List of the parameters used by the query.
 void setQueryString(String pVal)
          Query, name of the query, or name of the table that returnes the field associated with the attribute query.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the attribute query.

Description

This name is defined when the query attribute is created
- either by calling the INgObjectType CreateAttribute method in the program code,
- or through ArcGIS Schematics Designer, when the attribute has been created.

Product Availability

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

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

setName

void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the attribute query.

Product Availability

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

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

getFieldName

String getFieldName()
                    throws IOException,
                           AutomationException
Name of the field related to the attribute query.

Product Availability

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

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

setFieldName

void setFieldName(String pVal)
                  throws IOException,
                         AutomationException
Name of the field related to the attribute query.

Product Availability

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

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

getDataSource

INgDataSource getDataSource()
                            throws IOException,
                                   AutomationException
Data source used by the query.

Product Availability

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

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

setDataSource

void setDataSource(INgDataSource pVal)
                   throws IOException,
                          AutomationException
Data source used by the query.

Product Availability

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

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

getQueryString

String getQueryString()
                      throws IOException,
                             AutomationException
Query, name of the query, or name of the table that returnes the field associated with the attribute query.

Product Availability

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

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

setQueryString

void setQueryString(String pVal)
                    throws IOException,
                           AutomationException
Query, name of the query, or name of the table that returnes the field associated with the attribute query.

Product Availability

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

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

getParameters

INgParameters getParameters()
                            throws IOException,
                                   AutomationException
List of the parameters used by the query.

Product Availability

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

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

setParameters

void setParameters(INgParameters pVal)
                   throws IOException,
                          AutomationException
List of the parameters used by the query.

Product Availability

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

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