com.esri.arcgis.geodatabase
Interface IXMLIndexTemplate

All Superinterfaces:

Serializable

All Known Implementing Classes:

XMLIndexTemplate

public interface IXMLIndexTemplate
extends Serializable

A standardized set of tags managed through a Geodatabase workspace.

Product Availability

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

Method Summary

String	getDescription() A textual description of the template.
IXMLIndexTags	getExcludedTags() The set of tags to be used for the ExcludedTags property of an XML Index.
IXMLIndexTags	getIncludedTags() The set of tags to be used for the IncludedTags property of an XML Index.
String	getName() A user defineable name which must be globally unique to the Geodatabase instance.
void	setDescription(String templateDescription) A textual description of the template.
void	setExcludedTagsByRef(IXMLIndexTags tags) The set of tags to be used for the ExcludedTags property of an XML Index.
void	setIncludedTagsByRef(IXMLIndexTags tags) The set of tags to be used for the IncludedTags property of an XML Index.
void	setName(String templateName) A user defineable name which must be globally unique to the Geodatabase instance.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

A user defineable name which must be globally unique to the Geodatabase instance.

Product Availability

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

Returns:

The templateName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String templateName)
             throws IOException,
                    AutomationException

A user defineable name which must be globally unique to the Geodatabase instance.

Product Availability

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

Parameters:

templateName - The templateName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIncludedTags

IXMLIndexTags getIncludedTags()
                              throws IOException,
                                     AutomationException

The set of tags to be used for the IncludedTags property of an XML Index.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IXMLIndexTags

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIncludedTagsByRef

void setIncludedTagsByRef(IXMLIndexTags tags)
                          throws IOException,
                                 AutomationException

The set of tags to be used for the IncludedTags property of an XML Index.

Product Availability

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

Parameters:

tags - A reference to a com.esri.arcgis.geodatabase.IXMLIndexTags (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludedTags

IXMLIndexTags getExcludedTags()
                              throws IOException,
                                     AutomationException

The set of tags to be used for the ExcludedTags property of an XML Index.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IXMLIndexTags

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludedTagsByRef

void setExcludedTagsByRef(IXMLIndexTags tags)
                          throws IOException,
                                 AutomationException

The set of tags to be used for the ExcludedTags property of an XML Index.

Product Availability

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

Parameters:

tags - A reference to a com.esri.arcgis.geodatabase.IXMLIndexTags (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 template.

Product Availability

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

Returns:

The templateDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String templateDescription)
                    throws IOException,
                           AutomationException

A textual description of the template.

Product Availability

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

Parameters:

templateDescription - The templateDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.