com.esri.arcgis.geodatabase
Interface IXMLIndexTemplateManage

All Superinterfaces:

Serializable

All Known Implementing Classes:

IXMLIndexTemplateManageProxy

public interface IXMLIndexTemplateManage
extends Serializable

Manages the collection of XML Index Templates for this Geodatabase instance.

Product Availability

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

Method Summary

IEnumXMLIndexTemplate	getTemplates() Retrieves the currently installed templates.
void	installTemplate(IXMLIndexTemplate newTemplate) Installs a new template.
void	populateIndexTags(IXMLIndexTemplate sourceTemplate, IXMLIndex index) Populate an XML Index's IncludedTags and ExcludedTags properties from an installed template.
void	uninstallTemplate(IXMLIndexTemplate existingTemplate) Uninstalls an existing template.

Method Detail

getTemplates

IEnumXMLIndexTemplate getTemplates()
                                   throws IOException,
                                          AutomationException

Retrieves the currently installed templates.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

installTemplate

void installTemplate(IXMLIndexTemplate newTemplate)
                     throws IOException,
                            AutomationException

Installs a new template.

Product Availability

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

Parameters:

newTemplate - A reference to a com.esri.arcgis.geodatabase.IXMLIndexTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

uninstallTemplate

void uninstallTemplate(IXMLIndexTemplate existingTemplate)
                       throws IOException,
                              AutomationException

Uninstalls an existing template.

Product Availability

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

Parameters:

existingTemplate - A reference to a com.esri.arcgis.geodatabase.IXMLIndexTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

populateIndexTags

void populateIndexTags(IXMLIndexTemplate sourceTemplate,
                       IXMLIndex index)
                       throws IOException,
                              AutomationException

Populate an XML Index's IncludedTags and ExcludedTags properties from an installed template.

Product Availability

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

Parameters:

sourceTemplate - A reference to a com.esri.arcgis.geodatabase.IXMLIndexTemplate (in)

index - A reference to a com.esri.arcgis.geodatabase.IXMLIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.