com.esri.arcgis.geodatabase
Interface IModelInfo

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
CoverageFeatureClassName, FeatureClass, FeatureClassName, FgdbFeatureClassName, FgdbTableName, Field, IModelInfoProxy, ObjectClass, ObjectClassName, RasterCatalog, RasterCatalogName, SchematicDiagramClass, SchematicElementClass, TableName

public interface IModelInfo
extends java.io.Serializable

Provides access to the model name of the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

When To Use

Object classes and fields in a geodatabase can have between one and three names. The name of the object class or field, which is the same as the name of the table or column in the DBMS in which the objects in the object class are stored, the alias name which the user can set for display purposes in end user applications. The third name is the model name which is a tool for developers of custom objects to use to guarantee the names of objects independent of the true name or alias name.

The ModelInfo interface can be used to get or set the model name for an object class, or a field in an object class in the geodatabase. You can also use the IClassSchemaEdit interface to modify the model names for object classes and fields.

Remarks

When using the IModelInfo object to alter an object class' or field's model name, you should first acquire an exclusive schema lock using the ISchemaLock interface to be sure that another application or user does not have the class open while you are trying to modify its schema.

You can QI for the IModelInfo interface from the IObjectClass interface to work with an object class' model name, or from IField to work with a field's model name.

Note that IModelInfo is also available on the lightweight TableName object.

See Also:
IObjectClass

Method Summary
 java.lang.String getModelName()
          The model name of the field.
 void setModelName(java.lang.String name)
          The model name of the field.
 

Method Detail

getModelName

public java.lang.String getModelName()
                              throws java.io.IOException,
                                     AutomationException
The model name of the field.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns the model name currently associated with the field or object class.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IField, IObjectClass, IClassSchemaEdit

setModelName

public void setModelName(java.lang.String name)
                  throws java.io.IOException,
                         AutomationException
The model name of the field.

Supported Platforms

Windows, Solaris, Linux

Remarks

Sets the model name for the field or object class.

Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IField, IFieldEdit, IObjectClass, IClassSchemaEdit