com.esri.arcgis.geoprocessing
Interface IGPFieldDomain

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPFieldDomain, GPMeasureFieldsDomain, GPQueryTableFieldsDomain, GPQueryTableIDsDomain, GPRAFieldDomain, GPRouteIDFieldsDomain

public interface IGPFieldDomain
extends Serializable

Provides access to the properties/methods of a geoprocessing field domain object.

Product Availability

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

Method Summary

void	addExcludeField(String name) Add exclude field.
void	addKeyField(String name) Add key field.
void	addType(int type) Add a field type.
void	deleteType(int type) Remove a field type.
int	getCount() Count.
String	getExcludeField(int index) Exclude field.
int	getExcludeFieldCount() Exclude field count.
String	getKeyField(int index) Key field.
int	getKeyFieldCount() Key field count.
int	getType(int index) Field type.
boolean	isFilterIndex() Indicates whether or not to filter fields based on whether or not they have an index.
boolean	isFilterIndexType() Indicates whether to filter fields that have or do not have an index.
IArray	makeList(IGPValue pValue) Make list.
void	removeExcludeField(int index) Remove exclude field.
void	removeKeyField(int index) Remove key field.
void	setIndexFilter(boolean filter, boolean type) Set index filter.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

Count.

Product Availability

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

Supported Platforms

Windows

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

int getType(int index)
            throws IOException,
                   AutomationException

Field type.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.geodatabase.esriFieldType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addType

void addType(int type)
             throws IOException,
                    AutomationException

Add a field type.

Product Availability

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

Supported Platforms

Windows

Parameters:

type - A com.esri.arcgis.geodatabase.esriFieldType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteType

void deleteType(int type)
                throws IOException,
                       AutomationException

Remove a field type.

Product Availability

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

Supported Platforms

Windows

Parameters:

type - A com.esri.arcgis.geodatabase.esriFieldType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeList

IArray makeList(IGPValue pValue)
                throws IOException,
                       AutomationException

Make list.

Product Availability

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

Supported Platforms

Windows

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexFilter

void setIndexFilter(boolean filter,
                    boolean type)
                    throws IOException,
                           AutomationException

Set index filter.

Product Availability

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

Supported Platforms

Windows

Parameters:

filter - The filter (in)

type - The type (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFilterIndex

boolean isFilterIndex()
                      throws IOException,
                             AutomationException

Indicates whether or not to filter fields based on whether or not they have an index.

Product Availability

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

Supported Platforms

Windows

Returns:

The pFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFilterIndexType

boolean isFilterIndexType()
                          throws IOException,
                                 AutomationException

Indicates whether to filter fields that have or do not have an index.

Product Availability

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

Supported Platforms

Windows

Returns:

The pType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyFieldCount

int getKeyFieldCount()
                     throws IOException,
                            AutomationException

Key field count.

Product Availability

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

Supported Platforms

Windows

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyField

String getKeyField(int index)
                   throws IOException,
                          AutomationException

Key field.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addKeyField

void addKeyField(String name)
                 throws IOException,
                        AutomationException

Add key field.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeKeyField

void removeKeyField(int index)
                    throws IOException,
                           AutomationException

Remove key field.

Product Availability

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

Supported Platforms

Windows

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludeFieldCount

int getExcludeFieldCount()
                         throws IOException,
                                AutomationException

Exclude field count.

Product Availability

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

Supported Platforms

Windows

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludeField

String getExcludeField(int index)
                       throws IOException,
                              AutomationException

Exclude field.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addExcludeField

void addExcludeField(String name)
                     throws IOException,
                            AutomationException

Add exclude field.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeExcludeField

void removeExcludeField(int index)
                        throws IOException,
                               AutomationException

Remove exclude field.

Product Availability

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

Supported Platforms

Windows

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.