com.esri.arcgis.geodatabase
Interface IConfigurationKeyword

All Superinterfaces:
Serializable
All Known Subinterfaces:
IConfigurationKeyword2
All Known Implementing Classes:
ConfigurationKeyword, IConfigurationKeyword2Proxy, IConfigurationKeywordProxy

public interface IConfigurationKeyword
extends Serializable

Provides access to members to supply information about configuration keywords.

Superseded By

IConfigurationKeyword2

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.

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:

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


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

Method Detail

getKeywordType

int getKeywordType()
                   throws IOException,
                          AutomationException
The type of the keyword.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriConfigurationKeywordType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException
The name of the keyword.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
The description of the keyword.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The desc
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getComments

String getComments()
                   throws IOException,
                          AutomationException
Any additional comments about the keyword.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The comments
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConfigurationParameters

IEnumConfigurationParameter getConfigurationParameters()
                                                       throws IOException,
                                                              AutomationException
Configuration parameters included in this keyword.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumConfigurationParameter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.