com.esri.arcgis.geoprocessing
Interface IGPFieldInfoProperty

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPFieldInfoProperty

public interface IGPFieldInfoProperty
extends Serializable

Provides access to the properties/methods of a field info property object.

Product Availability

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

Method Summary

String	getAlias() FieldInfo Property Alias.
int	getIndex() FieldInfo Property Index.
String	getName() FieldInfo Property Name.
int	getSplitRule() FieldInfo Property Split Rule.
boolean	isHasError() Indicates whether or not the field info property has an error.
boolean	isVisible() Indicates whether or not the field is visible.
void	setAlias(String alias) FieldInfo Property Alias.
void	setHasError(boolean error) Indicates whether or not the field info property has an error.
void	setIndex(int index) FieldInfo Property Index.
void	setName(String name) FieldInfo Property Name.
void	setSplitRule(int rule) FieldInfo Property Split Rule.
void	setVisible(boolean visible) Indicates whether or not the field is visible.

Method Detail

getIndex

int getIndex()
             throws IOException,
                    AutomationException

FieldInfo Property Index.

Product Availability

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

Supported Platforms

Windows

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndex

void setIndex(int index)
              throws IOException,
                     AutomationException

FieldInfo Property Index.

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.

getName

String getName()
               throws IOException,
                      AutomationException

FieldInfo Property Name.

Product Availability

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

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

FieldInfo Property Name.

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.

getAlias

String getAlias()
                throws IOException,
                       AutomationException

FieldInfo Property Alias.

Product Availability

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

Supported Platforms

Windows

Returns:

The alias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlias

void setAlias(String alias)
              throws IOException,
                     AutomationException

FieldInfo Property Alias.

Product Availability

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

Supported Platforms

Windows

Parameters:

alias - The alias (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSplitRule

int getSplitRule()
                 throws IOException,
                        AutomationException

FieldInfo Property Split Rule.

Product Availability

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

Supported Platforms

Windows

Returns:

A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSplitRule

void setSplitRule(int rule)
                  throws IOException,
                         AutomationException

FieldInfo Property Split Rule.

Product Availability

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

Supported Platforms

Windows

Parameters:

rule - A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates whether or not the field is visible.

Product Availability

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

Supported Platforms

Windows

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates whether or not the field is visible.

Product Availability

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

Supported Platforms

Windows

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasError

boolean isHasError()
                   throws IOException,
                          AutomationException

Indicates whether or not the field info property has an error.

Product Availability

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

Supported Platforms

Windows

Returns:

The error

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasError

void setHasError(boolean error)
                 throws IOException,
                        AutomationException

Indicates whether or not the field info property has an error.

Product Availability

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

Supported Platforms

Windows

Parameters:

error - The error (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.