com.esri.arcgis.geodatabase
Interface IXMLIndexTag

All Superinterfaces:

Serializable

All Known Implementing Classes:

XMLIndexTag

public interface IXMLIndexTag
extends Serializable

Describes the properties used to index a tag in an XML document.

Product Availability

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

Method Summary

int	getDataType() The data type classification of the index tag.
String	getDescription() A textual description of the index tag.
int	getLocationAlias() An optional property which associates a number with the index tag.
String	getName() The name formatted as the full locational path of the XML schema.
void	setDataType(int dataType) The data type classification of the index tag.
void	setDescription(String tagDescription) A textual description of the index tag.
void	setLocationAlias(int alias) An optional property which associates a number with the index tag.
void	setName(String indexName) The name formatted as the full locational path of the XML schema.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name formatted as the full locational path of the XML schema.

Product Availability

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

Returns:

The indexName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String indexName)
             throws IOException,
                    AutomationException

The name formatted as the full locational path of the XML schema.

Product Availability

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

Parameters:

indexName - The indexName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

int getDataType()
                throws IOException,
                       AutomationException

The data type classification of the index tag.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriXMLIndexTagDataType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataType

void setDataType(int dataType)
                 throws IOException,
                        AutomationException

The data type classification of the index tag.

Product Availability

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

Parameters:

dataType - A com.esri.arcgis.geodatabase.esriXMLIndexTagDataType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationAlias

int getLocationAlias()
                     throws IOException,
                            AutomationException

An optional property which associates a number with the index tag.

Product Availability

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

Returns:

The alias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationAlias

void setLocationAlias(int alias)
                      throws IOException,
                             AutomationException

An optional property which associates a number with the index tag.

Product Availability

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

Parameters:

alias - The alias (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

A textual description of the index tag.

Product Availability

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

Returns:

The tagDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String tagDescription)
                    throws IOException,
                           AutomationException

A textual description of the index tag.

Product Availability

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

Parameters:

tagDescription - The tagDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.