com.esri.arcgis.geodatabase
Interface IConfigurationKeyword

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IConfigurationKeyword2

All Known Implementing Classes:

ConfigurationKeyword, IConfigurationKeyword2Proxy, IConfigurationKeywordProxy

public interface IConfigurationKeyword

extends java.io.Serializable

Provides access to members to supply information about configuration keywords.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

This interface is used for retrieving the properties of a configuration keyword. If the intention is to set the properties of a configuration keyword then IConfigurationKeyword2 should be used.

When To Use

Use the IConfigurationKeyword interface to get information about a configuration keyword. For example, through this interface, you can retrieve a name, description and the set of configuration parameters that this keyword represents.

Remarks

Configuration keywords are used in an ArcSDE or File geodatabase to specify storage parameters for new tables, feature classes and other datasets such as geometric networks, topologies and terrains when they are created. Configuration keywords can be of several different types:

• esriConfigurationKeywordGeneral which references storage parameters for creating feature classes and tables
• esriConfigurationKeywordNetwork which reference storage parameters for creating geometric networks
• esriConfigurationKeywordTopology which reference storage parameters for creating topologies
• esriConfigurationKeywordTerrain which reference storage parameters for creating terrain datasets
• esriConfigurationKeywordNetworkDatasets which reference storage parameters for creating network datasets

The following are examples of some of the methods that accept configuration keywords. These methods do not require an IConfigurationKeyword paramater, but require the name of a configuration keyword as a String:

IFeatureWorkspace::CreateFeatureClass
IFeatureWorkspace::CreateTable
IFeatureWorkspaceAnno::CreateAnnotationClass
IFeatureDataSet::CreateFeatureClass
IClassSchemaEdit::RergisterAsObjectClass
IFeatureDataConverter::ConvertFeatureClass
IFeatureDataConverter::ConvertFeatureDataset
IFeatureDataConverter::ConvertTable
IFeatureDataConverter2::ConvertFeatureClass
IFeatureDataConverter2::ConvertTable
IRouteMeasureEventGeoprocessor::Concatenate
IRouteMeasureEventGeoprocessor::Dissolve
IRouteMeasureEventGeoprocessor::Intersect
IRouteMeasureEventGeoprocessor::Union
INetworkLoader2::ConfigurationKeyword
ITopologyContainer::CreateTopology

Method Summary

java.lang.String	getComments() Any additional comments about the keyword.
IEnumConfigurationParameter	getConfigurationParameters() Configuration parameters included in this keyword.
java.lang.String	getDescription() The description of the keyword.
int	getKeywordType() The type of the keyword.
java.lang.String	getName() The name of the keyword.

Method Detail

getKeywordType

public int getKeywordType()
                   throws java.io.IOException,
                          AutomationException

The type of the keyword.

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.esriConfigurationKeywordType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the keyword.

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

The description of the keyword.

Supported Platforms

Windows, Solaris, Linux

Remarks

Configuration keywords in an ArcSDE or File geodatabase can have descriptions associated with them. A keyword's description is a user-friendly string that describes the configuration keyword.

Returns:

The desc

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getComments

public java.lang.String getComments()
                             throws java.io.IOException,
                                    AutomationException

Any additional comments about the keyword.

Supported Platforms

Windows, Solaris, Linux

Remarks

Configuration keywords in an ArcSDE or File geodatabase can have descriptions associated with them. A keyword's description is text that describes what the configuration keyword is used for.

Returns:

The comments

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationParameters

public IEnumConfigurationParameter getConfigurationParameters()
                                                       throws java.io.IOException,
                                                              AutomationException

Configuration parameters included in this keyword.

Supported Platforms

Windows, Solaris, Linux

Remarks

Configuration keywords in an ArcSDE or File geodatabase are used to specify storage parameters for feature class, tables and geometric networks. These storage parameters can be accessed through the IConfigurationParameters interface. This method returns a collection of parameters for a configuration keyword.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.