com.esri.arcgis.geodatabase
Class IConfigurationKeywordProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabase.IConfigurationKeywordProxy
All Implemented Interfaces:
IConfigurationKeyword, Externalizable, Serializable
Direct Known Subclasses:
IConfigurationKeyword2Proxy

public class IConfigurationKeywordProxy
extends com.esri.arcgis.interop.Dispatch
implements IConfigurationKeyword, 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

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IConfigurationKeywordProxy()
           
  IConfigurationKeywordProxy(Object obj)
           
protected IConfigurationKeywordProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IConfigurationKeywordProxy

public IConfigurationKeywordProxy()

IConfigurationKeywordProxy

public IConfigurationKeywordProxy(Object obj)
                           throws IOException
Throws:
IOException

IConfigurationKeywordProxy

protected IConfigurationKeywordProxy(Object obj,
                                     String iid)
                              throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getKeywordType

public 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

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

getName

public 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

Specified by:
getName in interface IConfigurationKeyword
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public 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

Specified by:
getDescription in interface IConfigurationKeyword
Returns:
The desc
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getComments

public 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

Specified by:
getComments in interface IConfigurationKeyword
Returns:
The comments
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConfigurationParameters

public 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

Specified by:
getConfigurationParameters in interface IConfigurationKeyword
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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException