com.esri.arcgis.datasourcesfile
Interface IGPArcInfoItem

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPArcInfoItem

public interface IGPArcInfoItem
extends Serializable

Provides access to the ArcInfo Item Data Element.

Product Availability

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

Method Summary

String	getAlternateName() The alternate name of the info item.
String	getName() The name of the info item.
int	getNumberDecimals() The number of decimal places of the info item.
int	getOutputWidth() The output width of the info item.
int	getStartPosition() The start position of the info item.
int	getType() The type of the info item.
int	getWidth() The width of the info item.
boolean	isIndexed() Indicates if the info item has an index.
boolean	isPseudo() Indicates if the item a psuedo item.
boolean	isRedefined() Indicates if the info item redefined.
void	setAlternateName(String alternateName) The alternate name of the info item.
void	setIsIndexed(boolean isIndexed) Indicates if the info item has an index.
void	setIsPseudo(boolean isPsuedo) Indicates if the item a psuedo item.
void	setIsRedefined(boolean redefined) Indicates if the info item redefined.
void	setName(String name) The name of the info item.
void	setNumberDecimals(int number) The number of decimal places of the info item.
void	setOutputWidth(int width) The output width of the info item.
void	setStartPosition(int position) The start position of the info item.
void	setType(int type) The type of the info item.
void	setWidth(int width) The width of the info item.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the info item.

Product Availability

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

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

The name of the info item.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartPosition

int getStartPosition()
                     throws IOException,
                            AutomationException

The start position of the info item.

Product Availability

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

Returns:

The position

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartPosition

void setStartPosition(int position)
                      throws IOException,
                             AutomationException

The start position of the info item.

Product Availability

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

Parameters:

position - The position (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

int getWidth()
             throws IOException,
                    AutomationException

The width of the info item.

Product Availability

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

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

void setWidth(int width)
              throws IOException,
                     AutomationException

The width of the info item.

Product Availability

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

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputWidth

int getOutputWidth()
                   throws IOException,
                          AutomationException

The output width of the info item.

Product Availability

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

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputWidth

void setOutputWidth(int width)
                    throws IOException,
                           AutomationException

The output width of the info item.

Product Availability

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

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws IOException,
                   AutomationException

The type of the info item.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesfile.esriArcInfoItemType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

void setType(int type)
             throws IOException,
                    AutomationException

The type of the info item.

Product Availability

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

Parameters:

type - A com.esri.arcgis.datasourcesfile.esriArcInfoItemType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberDecimals

int getNumberDecimals()
                      throws IOException,
                             AutomationException

The number of decimal places of the info item.

Product Availability

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

Returns:

The number

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberDecimals

void setNumberDecimals(int number)
                       throws IOException,
                              AutomationException

The number of decimal places of the info item.

Product Availability

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

Parameters:

number - The number (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlternateName

String getAlternateName()
                        throws IOException,
                               AutomationException

The alternate name of the info item.

Product Availability

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

Returns:

The alternateName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlternateName

void setAlternateName(String alternateName)
                      throws IOException,
                             AutomationException

The alternate name of the info item.

Product Availability

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

Parameters:

alternateName - The alternateName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRedefined

boolean isRedefined()
                    throws IOException,
                           AutomationException

Indicates if the info item redefined.

Product Availability

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

Returns:

The redefined

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsRedefined

void setIsRedefined(boolean redefined)
                    throws IOException,
                           AutomationException

Indicates if the info item redefined.

Product Availability

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

Parameters:

redefined - The redefined (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIndexed

boolean isIndexed()
                  throws IOException,
                         AutomationException

Indicates if the info item has an index.

Product Availability

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

Returns:

The isIndexed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsIndexed

void setIsIndexed(boolean isIndexed)
                  throws IOException,
                         AutomationException

Indicates if the info item has an index.

Product Availability

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

Parameters:

isIndexed - The isIndexed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPseudo

boolean isPseudo()
                 throws IOException,
                        AutomationException

Indicates if the item a psuedo item.

Product Availability

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

Returns:

The isPsuedo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPseudo

void setIsPseudo(boolean isPsuedo)
                 throws IOException,
                        AutomationException

Indicates if the item a psuedo item.

Product Availability

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

Parameters:

isPsuedo - The isPsuedo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.