Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.schematic
Class SchematicElementClass

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicElementClass
All Implemented Interfaces:
IClass, IClassHelper, IClassSchemaEdit, IClassSchemaEdit2, IDataset, IDatasetEdit, IDatasetEditInfo, IGeoDataset, IMetadata, IMetadataEdit, IModelInfo, IObjectClass, IObjectClassInfo, IObjectClassInfo2, ISchemaLock, ISubtypes, ITable, ITableCapabilities, IValidation, IValidation2, com.esri.arcgis.interop.RemoteObjRef, ISchematicAttributeContainer, ISchematicAttributeDesign, ISchematicElementAssociationContainer, ISchematicElementClass, ISchematicElementClassContainer, ISchematicObjectClass, ISchematicObjectClassContainer, java.io.Serializable
public class SchematicElementClass
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicElementClass, ISchematicObjectClass, IDataset, IGeoDataset, IDatasetEdit, IDatasetEditInfo, IClass, IClassSchemaEdit, IClassSchemaEdit2, ITable, ITableCapabilities, IModelInfo, ISchemaLock, IObjectClass, IObjectClassInfo, IObjectClassInfo2, ISubtypes, IValidation, IValidation2, IMetadata, IMetadataEdit, ISchematicElementAssociationContainer, ISchematicElementClassContainer, IClassHelper, ISchematicObjectClassContainer, ISchematicAttributeDesign, ISchematicAttributeContainer

COM Class 'SchematicElementClass'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description 'Schematic element class object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicElementClass
IID, IID7e29935b_54bc_4499_a2af_b779729f702c, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicObjectClass
IID55d6b6d9_5539_486f_95f8_084ef4e6fc13
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDataset
IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetEdit
IID, IID448c5d21_9746_11d1_89e2_006097aff44e, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetEditInfo
IID, IID234c31c1_9740_11d1_89e2_006097aff44e, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IClassSchemaEdit2
IID, IID62f1f470_e991_11d3_80d3_00c04f601565, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IClassSchemaEdit
IID64654191_e2e8_11d2_8a56_000000000000
 
Fields inherited from interface com.esri.arcgis.geodatabase.ITable
IID, IIDfcb01cb5_9f0b_11d0_bec7_00805f7c4268, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ITableCapabilities
IID, IID8b0338b9_3b3d_11d4_9fbb_00c04f6bdf0c, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IModelInfo
IID, IID2d660904_1dbd_11d3_9f87_00c04f6bdd84, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ISchemaLock
IID, IIDdca648e5_0fbb_11d3_80a5_00c04f686238, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IObjectClass
IID, IID1afcdb31_ac09_11d2_8a1e_006097aff44e, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IClass
IID1afcdb32_ac09_11d2_8a1e_006097aff44e
 
Fields inherited from interface com.esri.arcgis.geodatabase.ISubtypes
IID, IIDaef78514_848f_11d2_aaba_00c04fa37b82, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IValidation2
IID, IID48469230_851c_11d4_a0c9_00c04f6bdd84, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IValidation
IIDd410a9ba_475a_11d2_9932_0000f80372b4
 
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata
IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadataEdit
IID, IID97fdb978_62a4_49c5_8252_b07837b33ee9, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicElementAssociationContainer
IID, IIDcfd4503f_e319_40a0_aefe_0079f9117f52, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicElementClassContainer
IID, IID4230a0cc_f3d2_4c90_87fd_e38bf4bf376d, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IClassHelper
IID, IID65ded622_a14e_11d3_9f97_00c04f6bdf0c, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicObjectClassContainer
IID, IID03841ddd_fae6_4812_8e35_f53ce093eceb, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicAttributeDesign
IID, IIDc49fa756_93ea_4c44_841e_9ac838ba3989, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicAttributeContainer
IID, IID98d2e810_bf2b_43a6_adf4_71a8e8b6b7e6, xxDummy
 
Constructor Summary
SchematicElementClass(java.lang.Object obj)
          Construct a SchematicElementClass using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void addField(IField field)
          Adds a field to this object class.
 void addIndex(IIndex index)
          Adds an index to this object class.
 void addRule(IRule rule)
          Adds the rule to the set of associated rules.
 void addSubtype(int subtypeCode, java.lang.String subtypeName)
          Adds the subtype to the set of associated subtypes.
 void alterAliasName(java.lang.String name)
          The alias name of the object class.
 void alterAssociatedObjectClass(ISchematicDataSource schematicDataSource, int objectClassID)
          Changes the associated object class to the schematic element class.
 void alterClassExtensionCLSID(IUID classExtensionCLSID, IPropertySet classExtensionProperties)
          Changes the class extension COM class associated with this database class.
 void alterClassExtensionProperties(IPropertySet classExtensionProperties)
          Changes the class extension properties associated with this object class.
 void alterDefaultValue(java.lang.String fieldName, java.lang.Object value)
          The default value of the object class field.
 void alterDomain(java.lang.String fieldName, IDomain domain)
          The default domain of the object class field.
 void alterFieldAliasName(java.lang.String fieldName, java.lang.String aliasName)
          The alias name of the object class field.
 void alterFieldModelName(java.lang.String fieldName, java.lang.String modelName)
          The model name of the object class field.
 void alterInstanceCLSID(IUID instanceCLSID)
          Changes the instance COM class associated with this database class.
 void alterModelName(java.lang.String name)
          The model name of the object class.
 void alterRule(IRule rule)
          Alter the existing validation rule.
 void alterSchematicAttributeCLSID(java.lang.String name, IUID uID)
          Changes the schematic attribute CLSID.
 boolean canBypassEditSession()
          Indicates if updates to objects can be safely made outside of an edit session.
 boolean canBypassStoreMethod()
          Indicates if updates to objects can bypass the Store method and OnChange notifications for efficiency.
 boolean canCopy()
          True if this dataset can be copied.
 boolean canDelete()
          True if this dataset can be deleted.
 boolean canRename()
          True if this dataset can be renamed.
 void changeSchemaLock(int schemaLock)
          Changes a schema lock.
 IDataset copy(java.lang.String copyName, IWorkspace copyWorkspace)
          Copies this dataset to a new dataset with the specified name.
 IRow createRow()
          Creates a row in the database with a system assigned object ID and null property values.
 IRowBuffer createRowBuffer()
          Creates a row buffer that can be used with an insert cursor.
 ISchematicAttribute createSchematicAttribute(java.lang.String name, IUID uID)
          Creates a schematic in memory attribute.
 ISchematicElement createSchematicElement(java.lang.String name, IGeometry geometry, ISchematicDiagram schematicDiagram)
          Creates a new schematic element in the specified schematic diagram.
 void delete()
          Deletes this dataset.
 void delete(boolean deleteDescendants)
          Deletes the schematic object class.
 void deleteField(IField field)
          Deletes a field from this object class.
 void deleteIndex(IIndex index)
          Deletes an index from this object class.
 void deleteRule(IRule rule)
          Deletes the rule from the set of associated rules.
 void deleteSearchedRows(IQueryFilter queryFilter)
          Delete the Rows in the database selected by the specified query.
 void deleteSubtype(int subtypeCode)
          Deletes the subtype from the set of associated subtypes.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClass esri_getClass()
          The class for this class helper.
 int findField(java.lang.String name)
          The index of the field with the specified name.
 java.lang.String getAliasName()
          The alias name of the object class.
 ISchematicDataSource getAssociatedObjectClassDataSource()
          The associated schematic data source to the schematic element class.
 int getAssociatedObjectClassDataSourceID()
          The associated object class data source ID to the schematic element class.
 int getAssociatedObjectClassID()
          The associated object class ID to the schematic element class.
 IEnumSchematicDiagramClass getAssociatedSchematicDiagramClasses()
          Associated diagram classes to the schematic element class.
 java.lang.String getBrowseName()
          The browse name of the dataset.
 java.lang.String getCategory()
          The category of the dataset.
 IUID getCLSID()
          The GUID for the COM Class (CoClass) corresponding to instances of this object class.
 void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
          The list of current locks.
 int getDefaultSubtypeCode()
          The default subtype associated with the class.
 java.lang.Object getDefaultValue(int subtypeCode, java.lang.String fieldName)
          The default value for the associated attribute.
 IDomain getDomain(int subtypeCode, java.lang.String fieldName)
          The domain given the subtype and field.
 IUID getEXTCLSID()
          The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
 java.lang.Object getExtension()
          The extension for this object class.
 IPropertySet getExtensionProperties()
          The extension properties for this object class.
 IEnvelope getExtent()
          The extent of the GeoDataset.
 int getExternalQueryEvaluationMode()
          External query evaluation mode of the schematic object class.
 IFields getFields()
          The fields collection for this object class.
 IName getFullName()
          The associated name object.
 int getGeometryType()
          Geometry type of the schematic element class.
 java.lang.Object getIdentifierFieldNames()
          Identifier fields names of the schematic object class.
 IIndexes getIndexes()
          The indexes collection for this object class.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 java.lang.String getModelName()
          The model name of the field.
 java.lang.String getName()
          Name of the schematic object class.
 int getObjectClassID()
          The unique ID for the object class.
 java.lang.String getOIDFieldName()
          The name of the field corresponding to the OID.
 ISchematicElementClass getParent()
          Parent to the schematic element class.
 java.lang.String[] getPredefinedAttributeNames()
          Predefined attributes names of the schematic in memory object class.
 IPropertySet getPropertySet()
          The set of properties for the dataset.
 java.lang.String getQueryString()
          Query string of the schematic object class.
 IUID getRelationManagerCLSID()
          Relation manager CLSID of the schematic element class.
 IEnumRelationshipClass getRelationshipClasses(int role)
          The relationship classes in which this object class participates in for the specified role.
 IRow getRow(int oID)
          The row from the database with the specified object ID.
 ICursor getRows(java.lang.Object oids, boolean recycling)
          The cursor of rows based on a set of object ids.
 IEnumRule getRules()
          The rules associated with the class.
 IEnumRule getRulesByField(java.lang.String fieldName)
          The rules associated with the attribute.
 IEnumRule getRulesBySubtypeCode(int subtypeCode)
          The rules associated with the subtype.
 ISchematicAttribute getSchematicAttribute(java.lang.String name, boolean recursiveSearch)
          Retrives recursively or not the schematic attribute referenced by the specified Name.
 IEnumSchematicAttribute getSchematicAttributes()
          Schematic attributes enumeration within the schematic attribute container.
 ISchematicDataset getSchematicDataset()
          Schematic dataset the schematic object class belongs to.
 ISchematicDataSource getSchematicDataSource()
          Schematic data source of the schematic object class.
 ISchematicElementAssociation getSchematicElementAssociationByID(int iD)
          Schematic element association referenced by the specified ID.
 IEnumSchematicElementAssociation getSchematicElementAssociations()
          Schematic element associations enumeration within the container.
 ISchematicElement getSchematicElementByID(int iD, ISchematicDiagram schematicDiagram)
          Schematic element referenced by the specified ID that is contained in the specified schematic diagram.
 ISchematicElement getSchematicElementByName(java.lang.String name, ISchematicDiagram schematicDiagram)
          Schematic element referenced by the specified Name that is contained in the specified schematic diagram.
 ISchematicElementClass getSchematicElementClass(java.lang.String name)
          Schematic diagram class referenced by the specified Name.
 IEnumSchematicElementClass getSchematicElementClasses()
          Schematic element classes enumeration within the schematic element class container.
 IEnumSchematicElement getSchematicElements(ISchematicDiagram schematicDiagram)
          List of the schematic elements related to the schematic element class within the specified schematic diagram.
 int getSchematicElementType()
          Schematic element type related to the schematic element class.
 ISchematicObjectClass getSchematicObjectClass(java.lang.String name)
          Schematic object class referenced by the specified Name.
 IEnumSchematicObjectClass getSchematicObjectClasses()
          Schematic object classes enumeration within the schematic object class container.
 IEnumSchematicQueryParameter getSchematicQueryParameters()
          Schematic query parameters of the schematic object class.
 IField getShapeField()
          Shape field of the schematic element class.
 ISpatialReference getSpatialReference()
          The spatial reference of the GeoDataset.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 int getSubtypeFieldIndex()
          The subtype field index.
 java.lang.String getSubtypeFieldName()
          The subtype field name.
 java.lang.String getSubtypeName(int subtypeCode)
          The subtype name.
 IEnumSubtype getSubtypes()
          The subtypes associated with the class.
 int getType()
          The type of the Dataset.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 int hashCode()
          the hashcode for this object
 ICursor insert(boolean useBuffering)
          Returns a cursor that can be used to insert new Rows.
 boolean isBeingEdited()
          True if the dataset is being edited.
 boolean isCanEdit()
          True if the dataset supports edit sessions with the ability to discard edits on save.
 boolean isCanEditMetadata()
          Indicates if metadata can be edited.
 boolean isCanRedo()
          True if the dataset supports edit sessions with the ability to redo undone operations.
 boolean isCanSelect()
          Indicates if the table supports selection.
 boolean isCanUndo()
          True if the dataset supports edit sessions with the ability to undo individual edit operations.
 boolean isHasOID()
          Indicates if the class has an object identity (OID) field.
 boolean isHasSubtype()
          Indicates if the table has subtypes.
 ICursor ITable_search(IQueryFilter queryFilter, boolean recycling)
          An object cursor that can be used to fetch row objects selected by the specified query.
 int registerAsObjectClass(java.lang.String suggestedOIDFieldName, java.lang.String configKeyword)
          Registers this class with the database, assigning it a class id and creating an object id column.
 void release()
          Release a SchematicElementClass.
 void rename(java.lang.String name)
          Renames this Dataset.
 int rowCount(IQueryFilter queryFilter)
          The number of Rows selected by the specified query.
 ISelectionSet select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer)
          A selection that contains the object ids selected by the specified query.
 void setBrowseName(java.lang.String name)
          The browse name of the dataset.
 void setDefaultSubtypeCode(int subtypeCode)
          The default subtype associated with the class.
 void setDefaultValue(int subtypeCode, java.lang.String fieldName, java.lang.Object value)
          The default value for the associated attribute.
 void setDomainByRef(int subtypeCode, java.lang.String fieldName, IDomain domain)
          The domain given the subtype and field.
 void setExternalQueryEvaluationMode(int externalQueryEvaluationMode)
          External query evaluation mode of the schematic object class.
 void setGeometryType(int geometryType)
          Geometry type of the schematic element class.
 void setIdentifierFieldNames(java.lang.Object names)
          Identifier fields names of the schematic object class.
 void setMetadata(IPropertySet propertySet)
          The PropertySet containing metadata.
 void setModelName(java.lang.String name)
          The model name of the field.
 void setName(java.lang.String name)
          Name of the schematic object class.
 void setParentByRef(ISchematicElementClass parent)
          Parent to the schematic element class.
 void setQueryString(java.lang.String queryString)
          Query string of the schematic object class.
 void setRelationManagerCLSID(IUID uID)
          Relation manager CLSID of the schematic element class.
 void setSchematicDataSourceByRef(ISchematicDataSource schematicDataSource)
          Schematic data source of the schematic object class.
 void setSchematicQueryParameters(IEnumSchematicQueryParameter queryParameters)
          Schematic query parameters of the schematic object class.
 void setShapeField(IField field)
          Shape field of the schematic element class.
 void setSubtypeFieldName(java.lang.String fieldName)
          The subtype field name.
 void synchronize(int action, int interval)
          Updates metadata with the current properties; may create metadata if it doesn't already exist.
 ICursor update(IQueryFilter queryFilter, boolean recycling)
          Returns a cursor that can be used to update Rows selected by the specified query.
 void updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer)
          Update the Rows in the database selected by the specified query.
 ISelectionSet validate(IQueryFilter selection, IWorkspace workspace)
          Validates the selection.
 ISelectionSet validateSelection(ISelectionSet selection, IWorkspace workspace)
          Validates the selection.
 ISet validateSet(ISet selection)
          Validates the set.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SchematicElementClass

public SchematicElementClass(java.lang.Object obj)
                      throws java.io.IOException
Construct a SchematicElementClass using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicElementClass.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
SchematicElementClass o = (SchematicElementClass)obj; // will not work

SchematicElementClass o = new SchematicElementClass(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems SchematicElementClass theSchematicElementClass = (SchematicElementClass) obj;
Method Detail

equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a SchematicElementClass.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

createSchematicElement

public ISchematicElement createSchematicElement(java.lang.String name,
                                                IGeometry geometry,
                                                ISchematicDiagram schematicDiagram)
                                         throws java.io.IOException,
                                                AutomationException
Creates a new schematic element in the specified schematic diagram.

Specified by:
createSchematicElement in interface ISchematicElementClass
Parameters:
name - The name (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicElements

public IEnumSchematicElement getSchematicElements(ISchematicDiagram schematicDiagram)
                                           throws java.io.IOException,
                                                  AutomationException
List of the schematic elements related to the schematic element class within the specified schematic diagram.

Specified by:
getSchematicElements in interface ISchematicElementClass
Parameters:
schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicElementByID

public ISchematicElement getSchematicElementByID(int iD,
                                                 ISchematicDiagram schematicDiagram)
                                          throws java.io.IOException,
                                                 AutomationException
Schematic element referenced by the specified ID that is contained in the specified schematic diagram.

Specified by:
getSchematicElementByID in interface ISchematicElementClass
Parameters:
iD - The iD (in)
schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicElementByName

public ISchematicElement getSchematicElementByName(java.lang.String name,
                                                   ISchematicDiagram schematicDiagram)
                                            throws java.io.IOException,
                                                   AutomationException
Schematic element referenced by the specified Name that is contained in the specified schematic diagram.

Specified by:
getSchematicElementByName in interface ISchematicElementClass
Parameters:
name - The name (in)
schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicElementType

public int getSchematicElementType()
                            throws java.io.IOException,
                                   AutomationException
Schematic element type related to the schematic element class.

Specified by:
getSchematicElementType in interface ISchematicElementClass
Returns:
A com.esri.arcgis.schematic.esriSchematicElementType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometryType

public int getGeometryType()
                    throws java.io.IOException,
                           AutomationException
Geometry type of the schematic element class.

Specified by:
getGeometryType in interface ISchematicElementClass
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeometryType

public void setGeometryType(int geometryType)
                     throws java.io.IOException,
                            AutomationException
Geometry type of the schematic element class.

Specified by:
setGeometryType in interface ISchematicElementClass
Parameters:
geometryType - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShapeField

public IField getShapeField()
                     throws java.io.IOException,
                            AutomationException
Shape field of the schematic element class.

Specified by:
getShapeField in interface ISchematicElementClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IField
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShapeField

public void setShapeField(IField field)
                   throws java.io.IOException,
                          AutomationException
Shape field of the schematic element class.

Specified by:
setShapeField in interface ISchematicElementClass
Parameters:
field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParent

public ISchematicElementClass getParent()
                                 throws java.io.IOException,
                                        AutomationException
Parent to the schematic element class.

Specified by:
getParent in interface ISchematicElementClass
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElementClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParentByRef

public void setParentByRef(ISchematicElementClass parent)
                    throws java.io.IOException,
                           AutomationException
Parent to the schematic element class.

Specified by:
setParentByRef in interface ISchematicElementClass
Parameters:
parent - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAssociatedSchematicDiagramClasses

public IEnumSchematicDiagramClass getAssociatedSchematicDiagramClasses()
                                                                throws java.io.IOException,
                                                                       AutomationException
Associated diagram classes to the schematic element class.

Specified by:
getAssociatedSchematicDiagramClasses in interface ISchematicElementClass
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicDiagramClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelationManagerCLSID

public IUID getRelationManagerCLSID()
                             throws java.io.IOException,
                                    AutomationException
Relation manager CLSID of the schematic element class.

Specified by:
getRelationManagerCLSID in interface ISchematicElementClass
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelationManagerCLSID

public void setRelationManagerCLSID(IUID uID)
                             throws java.io.IOException,
                                    AutomationException
Relation manager CLSID of the schematic element class.

Specified by:
setRelationManagerCLSID in interface ISchematicElementClass
Parameters:
uID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAssociatedObjectClassID

public int getAssociatedObjectClassID()
                               throws java.io.IOException,
                                      AutomationException
The associated object class ID to the schematic element class.

Specified by:
getAssociatedObjectClassID in interface ISchematicElementClass
Returns:
The iD
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAssociatedObjectClassDataSourceID

public int getAssociatedObjectClassDataSourceID()
                                         throws java.io.IOException,
                                                AutomationException
The associated object class data source ID to the schematic element class.

Specified by:
getAssociatedObjectClassDataSourceID in interface ISchematicElementClass
Returns:
The iD
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAssociatedObjectClassDataSource

public ISchematicDataSource getAssociatedObjectClassDataSource()
                                                        throws java.io.IOException,
                                                               AutomationException
The associated schematic data source to the schematic element class.

Specified by:
getAssociatedObjectClassDataSource in interface ISchematicElementClass
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDataSource
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterAssociatedObjectClass

public void alterAssociatedObjectClass(ISchematicDataSource schematicDataSource,
                                       int objectClassID)
                                throws java.io.IOException,
                                       AutomationException
Changes the associated object class to the schematic element class.

Specified by:
alterAssociatedObjectClass in interface ISchematicElementClass
Parameters:
schematicDataSource - A reference to a com.esri.arcgis.schematic.ISchematicDataSource (in)
objectClassID - The objectClassID (in)
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
Name of the schematic object class.

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

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Name of the schematic object class.

Specified by:
setName in interface ISchematicObjectClass
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDataset

public ISchematicDataset getSchematicDataset()
                                      throws java.io.IOException,
                                             AutomationException
Schematic dataset the schematic object class belongs to.

Specified by:
getSchematicDataset in interface ISchematicObjectClass
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicQueryParameters

public IEnumSchematicQueryParameter getSchematicQueryParameters()
                                                         throws java.io.IOException,
                                                                AutomationException
Schematic query parameters of the schematic object class.

Specified by:
getSchematicQueryParameters in interface ISchematicObjectClass
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicQueryParameter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSchematicQueryParameters

public void setSchematicQueryParameters(IEnumSchematicQueryParameter queryParameters)
                                 throws java.io.IOException,
                                        AutomationException
Schematic query parameters of the schematic object class.

Specified by:
setSchematicQueryParameters in interface ISchematicObjectClass
Parameters:
queryParameters - A reference to a com.esri.arcgis.schematic.IEnumSchematicQueryParameter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getQueryString

public java.lang.String getQueryString()
                                throws java.io.IOException,
                                       AutomationException
Query string of the schematic object class.

Specified by:
getQueryString in interface ISchematicObjectClass
Returns:
The queryString
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setQueryString

public void setQueryString(java.lang.String queryString)
                    throws java.io.IOException,
                           AutomationException
Query string of the schematic object class.

Specified by:
setQueryString in interface ISchematicObjectClass
Parameters:
queryString - The queryString (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIdentifierFieldNames

public java.lang.Object getIdentifierFieldNames()
                                         throws java.io.IOException,
                                                AutomationException
Identifier fields names of the schematic object class.

Specified by:
getIdentifierFieldNames in interface ISchematicObjectClass
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIdentifierFieldNames

public void setIdentifierFieldNames(java.lang.Object names)
                             throws java.io.IOException,
                                    AutomationException
Identifier fields names of the schematic object class.

Specified by:
setIdentifierFieldNames in interface ISchematicObjectClass
Parameters:
names - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDataSource

public ISchematicDataSource getSchematicDataSource()
                                            throws java.io.IOException,
                                                   AutomationException
Schematic data source of the schematic object class.

Specified by:
getSchematicDataSource in interface ISchematicObjectClass
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDataSource
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSchematicDataSourceByRef

public void setSchematicDataSourceByRef(ISchematicDataSource schematicDataSource)
                                 throws java.io.IOException,
                                        AutomationException
Schematic data source of the schematic object class.

Specified by:
setSchematicDataSourceByRef in interface ISchematicObjectClass
Parameters:
schematicDataSource - A reference to a com.esri.arcgis.schematic.ISchematicDataSource (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete(boolean deleteDescendants)
            throws java.io.IOException,
                   AutomationException
Deletes the schematic object class.

Specified by:
delete in interface ISchematicObjectClass
Parameters:
deleteDescendants - The deleteDescendants (in, optional, pass true if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createSchematicAttribute

public ISchematicAttribute createSchematicAttribute(java.lang.String name,
                                                    IUID uID)
                                             throws java.io.IOException,
                                                    AutomationException
Creates a schematic in memory attribute.

Specified by:
createSchematicAttribute in interface ISchematicObjectClass
Parameters:
name - The name (in)
uID - A reference to a com.esri.arcgis.system.IUID (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicAttribute
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPredefinedAttributeNames

public java.lang.String[] getPredefinedAttributeNames()
                                               throws java.io.IOException,
                                                      AutomationException
Predefined attributes names of the schematic in memory object class.

Specified by:
getPredefinedAttributeNames in interface ISchematicObjectClass
Returns:
The names
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExternalQueryEvaluationMode

public void setExternalQueryEvaluationMode(int externalQueryEvaluationMode)
                                    throws java.io.IOException,
                                           AutomationException
External query evaluation mode of the schematic object class.

Specified by:
setExternalQueryEvaluationMode in interface ISchematicObjectClass
Parameters:
externalQueryEvaluationMode - A com.esri.arcgis.schematic.esriSchematicExternalQueryEvaluationMode constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExternalQueryEvaluationMode

public int getExternalQueryEvaluationMode()
                                   throws java.io.IOException,
                                          AutomationException
External query evaluation mode of the schematic object class.

Specified by:
getExternalQueryEvaluationMode in interface ISchematicObjectClass
Returns:
A com.esri.arcgis.schematic.esriSchematicExternalQueryEvaluationMode constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException
The associated name object.

Specified by:
getFullName in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBrowseName

public java.lang.String getBrowseName()
                               throws java.io.IOException,
                                      AutomationException
The browse name of the dataset.

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

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
The browse name of the dataset.

Specified by:
setBrowseName in interface IDataset
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException
The type of the Dataset.

Specified by:
getType in interface IDataset
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
The category of the dataset.

Specified by:
getCategory in interface IDataset
Returns:
The category
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException
Datasets contained within this dataset.

Specified by:
getSubsets in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException
The workspace containing this dataset.

Specified by:
getWorkspace in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException
The set of properties for the dataset.

Specified by:
getPropertySet in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException
True if this dataset can be copied.

Specified by:
canCopy in interface IDataset
Returns:
The canCopy
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException
Copies this dataset to a new dataset with the specified name.

Specified by:
copy in interface IDataset
Parameters:
copyName - The copyName (in)
copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException
True if this dataset can be deleted.

Specified by:
canDelete in interface IDataset
Returns:
The canDelete
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException
Deletes this dataset.

Specified by:
delete in interface IDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException
True if this dataset can be renamed.

Specified by:
canRename in interface IDataset
Returns:
The canRename
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException
Renames this Dataset.

Specified by:
rename in interface IDataset
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
The spatial reference of the GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSpatialReference in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
The extent of the GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBeingEdited

public boolean isBeingEdited()
                      throws java.io.IOException,
                             AutomationException
True if the dataset is being edited.

Specified by:
isBeingEdited in interface IDatasetEdit
Returns:
The isBeingEdited
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanEdit

public boolean isCanEdit()
                  throws java.io.IOException,
                         AutomationException
True if the dataset supports edit sessions with the ability to discard edits on save.

Specified by:
isCanEdit in interface IDatasetEditInfo
Returns:
The canEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanUndo

public boolean isCanUndo()
                  throws java.io.IOException,
                         AutomationException
True if the dataset supports edit sessions with the ability to undo individual edit operations.

Specified by:
isCanUndo in interface IDatasetEditInfo
Returns:
The canUndo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanRedo

public boolean isCanRedo()
                  throws java.io.IOException,
                         AutomationException
True if the dataset supports edit sessions with the ability to redo undone operations.

Specified by:
isCanRedo in interface IDatasetEditInfo
Returns:
The canUndo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findField

public int findField(java.lang.String name)
              throws java.io.IOException,
                     AutomationException
The index of the field with the specified name.

Specified by:
findField in interface IClass
Parameters:
name - The name (in)
Returns:
The fieldIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException
The fields collection for this object class.

Specified by:
getFields in interface IClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIndexes

public IIndexes getIndexes()
                    throws java.io.IOException,
                           AutomationException
The indexes collection for this object class.

Specified by:
getIndexes in interface IClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IIndexes
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addField

public void addField(IField field)
              throws java.io.IOException,
                     AutomationException
Adds a field to this object class.

Specified by:
addField in interface IClass
Parameters:
field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws java.io.IOException,
                        AutomationException
Deletes a field from this object class.

Specified by:
deleteField in interface IClass
Parameters:
field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addIndex

public void addIndex(IIndex index)
              throws java.io.IOException,
                     AutomationException
Adds an index to this object class.

Specified by:
addIndex in interface IClass
Parameters:
index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteIndex

public void deleteIndex(IIndex index)
                 throws java.io.IOException,
                        AutomationException
Deletes an index from this object class.

Specified by:
deleteIndex in interface IClass
Parameters:
index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws java.io.IOException,
                        AutomationException
Indicates if the class has an object identity (OID) field.

Specified by:
isHasOID in interface IClass
Returns:
The hasOID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

public java.lang.String getOIDFieldName()
                                 throws java.io.IOException,
                                        AutomationException
The name of the field corresponding to the OID.

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

getCLSID

public IUID getCLSID()
              throws java.io.IOException,
                     AutomationException
The GUID for the COM Class (CoClass) corresponding to instances of this object class.

Specified by:
getCLSID in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

public IUID getEXTCLSID()
                 throws java.io.IOException,
                        AutomationException
The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.

Specified by:
getEXTCLSID in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtension

public java.lang.Object getExtension()
                              throws java.io.IOException,
                                     AutomationException
The extension for this object class.

Specified by:
getExtension in interface IClass
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

public IPropertySet getExtensionProperties()
                                    throws java.io.IOException,
                                           AutomationException
The extension properties for this object class.

Specified by:
getExtensionProperties in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerAsObjectClass

public int registerAsObjectClass(java.lang.String suggestedOIDFieldName,
                                 java.lang.String configKeyword)
                          throws java.io.IOException,
                                 AutomationException
Registers this class with the database, assigning it a class id and creating an object id column.

Specified by:
registerAsObjectClass in interface IClassSchemaEdit
Parameters:
suggestedOIDFieldName - The suggestedOIDFieldName (in)
configKeyword - The configKeyword (in)
Returns:
The objectClassID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterInstanceCLSID

public void alterInstanceCLSID(IUID instanceCLSID)
                        throws java.io.IOException,
                               AutomationException
Changes the instance COM class associated with this database class.

Specified by:
alterInstanceCLSID in interface IClassSchemaEdit
Parameters:
instanceCLSID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterClassExtensionCLSID

public void alterClassExtensionCLSID(IUID classExtensionCLSID,
                                     IPropertySet classExtensionProperties)
                              throws java.io.IOException,
                                     AutomationException
Changes the class extension COM class associated with this database class.

Specified by:
alterClassExtensionCLSID in interface IClassSchemaEdit
Parameters:
classExtensionCLSID - A reference to a com.esri.arcgis.system.IUID (in)
classExtensionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterAliasName

public void alterAliasName(java.lang.String name)
                    throws java.io.IOException,
                           AutomationException
The alias name of the object class.

Specified by:
alterAliasName in interface IClassSchemaEdit
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterFieldAliasName

public void alterFieldAliasName(java.lang.String fieldName,
                                java.lang.String aliasName)
                         throws java.io.IOException,
                                AutomationException
The alias name of the object class field.

Specified by:
alterFieldAliasName in interface IClassSchemaEdit
Parameters:
fieldName - The fieldName (in)
aliasName - The aliasName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterModelName

public void alterModelName(java.lang.String name)
                    throws java.io.IOException,
                           AutomationException
The model name of the object class.

Specified by:
alterModelName in interface IClassSchemaEdit
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterFieldModelName

public void alterFieldModelName(java.lang.String fieldName,
                                java.lang.String modelName)
                         throws java.io.IOException,
                                AutomationException
The model name of the object class field.

Specified by:
alterFieldModelName in interface IClassSchemaEdit
Parameters:
fieldName - The fieldName (in)
modelName - The modelName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterDomain

public void alterDomain(java.lang.String fieldName,
                        IDomain domain)
                 throws java.io.IOException,
                        AutomationException
The default domain of the object class field.

Specified by:
alterDomain in interface IClassSchemaEdit
Parameters:
fieldName - The fieldName (in)
domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterDefaultValue

public void alterDefaultValue(java.lang.String fieldName,
                              java.lang.Object value)
                       throws java.io.IOException,
                              AutomationException
The default value of the object class field.

Specified by:
alterDefaultValue in interface IClassSchemaEdit
Parameters:
fieldName - The fieldName (in)
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterClassExtensionProperties

public void alterClassExtensionProperties(IPropertySet classExtensionProperties)
                                   throws java.io.IOException,
                                          AutomationException
Changes the class extension properties associated with this object class.

Specified by:
alterClassExtensionProperties in interface IClassSchemaEdit2
Parameters:
classExtensionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRow

public IRow createRow()
               throws java.io.IOException,
                      AutomationException
Creates a row in the database with a system assigned object ID and null property values.

Specified by:
createRow in interface ITable
Returns:
A reference to a com.esri.arcgis.geodatabase.IRow
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws java.io.IOException,
                   AutomationException
The row from the database with the specified object ID.

Specified by:
getRow in interface ITable
Parameters:
oID - The oID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRow
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRows

public ICursor getRows(java.lang.Object oids,
                       boolean recycling)
                throws java.io.IOException,
                       AutomationException
The cursor of rows based on a set of object ids.

Specified by:
getRows in interface ITable
Parameters:
oids - A Variant (in)
recycling - The recycling (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws java.io.IOException,
                                  AutomationException
Creates a row buffer that can be used with an insert cursor.

Specified by:
createRowBuffer in interface ITable
Returns:
A reference to a com.esri.arcgis.geodatabase.IRowBuffer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateSearchedRows

public void updateSearchedRows(IQueryFilter queryFilter,
                               IRowBuffer buffer)
                        throws java.io.IOException,
                               AutomationException
Update the Rows in the database selected by the specified query.

Specified by:
updateSearchedRows in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
buffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteSearchedRows

public void deleteSearchedRows(IQueryFilter queryFilter)
                        throws java.io.IOException,
                               AutomationException
Delete the Rows in the database selected by the specified query.

Specified by:
deleteSearchedRows in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws java.io.IOException,
                    AutomationException
The number of Rows selected by the specified query.

Specified by:
rowCount in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:
The numRows
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

ITable_search

public ICursor ITable_search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws java.io.IOException,
                             AutomationException
An object cursor that can be used to fetch row objects selected by the specified query.

Specified by:
ITable_search in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
recycling - The recycling (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public ICursor update(IQueryFilter queryFilter,
                      boolean recycling)
               throws java.io.IOException,
                      AutomationException
Returns a cursor that can be used to update Rows selected by the specified query.

Specified by:
update in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
recycling - The recycling (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws java.io.IOException,
                      AutomationException
Returns a cursor that can be used to insert new Rows.

Specified by:
insert in interface ITable
Parameters:
useBuffering - The useBuffering (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

select

public ISelectionSet select(IQueryFilter queryFilter,
                            int selType,
                            int selOption,
                            IWorkspace selectionContainer)
                     throws java.io.IOException,
                            AutomationException
A selection that contains the object ids selected by the specified query.

Specified by:
select in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)
selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)
selectionContainer - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanSelect

public boolean isCanSelect()
                    throws java.io.IOException,
                           AutomationException
Indicates if the table supports selection.

Specified by:
isCanSelect in interface ITableCapabilities
Returns:
The canSelect
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getModelName

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

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

setModelName

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

Specified by:
setModelName in interface IModelInfo
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

changeSchemaLock

public void changeSchemaLock(int schemaLock)
                      throws java.io.IOException,
                             AutomationException
Changes a schema lock.

Specified by:
changeSchemaLock in interface ISchemaLock
Parameters:
schemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentSchemaLocks

public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
                           throws java.io.IOException,
                                  AutomationException
The list of current locks.

Specified by:
getCurrentSchemaLocks in interface ISchemaLock
Parameters:
schemaLockInfo - A reference to a com.esri.arcgis.geodatabase.IEnumSchemaLockInfo (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObjectClassID

public int getObjectClassID()
                     throws java.io.IOException,
                            AutomationException
The unique ID for the object class.

Specified by:
getObjectClassID in interface IObjectClass
Returns:
The objectClassID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses(int role)
                                              throws java.io.IOException,
                                                     AutomationException
The relationship classes in which this object class participates in for the specified role.

Specified by:
getRelationshipClasses in interface IObjectClass
Parameters:
role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRelationshipClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAliasName

public java.lang.String getAliasName()
                              throws java.io.IOException,
                                     AutomationException
The alias name of the object class.

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

canBypassStoreMethod

public boolean canBypassStoreMethod()
                             throws java.io.IOException,
                                    AutomationException
Indicates if updates to objects can bypass the Store method and OnChange notifications for efficiency.

Remarks

CanBypassStoreMethod is a convenience method that returns True if the instances of this object class have no custom behavior associated with creating or updating objects and if the object class does not participate in composite relationship classes or in relationship classes that require object notification. A return value of True implies that insert cursors handed out by the geodatabase will internally bypass the CreateRow and Store mechanisms when creating objects. A return value of False indicates that insert cursors will not bypass custom Store or OnChanged behavior implemented by the custom row object for this class.

By default, this method returns False for custom object classes. The developer of a custom object class can change this behavior by implementing this interface on the class extension associated with the class and returning True for the method.

In addition, a developer can implement this interface on the class extension of a simple class and set this property to False . Doing this will ensure that when features in the class are inserted, updated or deleted by editor tools that use insert and update cursors, such as Planarize, Create Features and the Object Loader do not bypass Store or OnChanged behavior. By default, this property for a simple class is logically True, meaning these tools will not broacast Geodatabase events which in turn are not rebroadcast as editor events (for which a custom editor application may be listening). Set this to False for those classes for which you always want to have these events broadcast. Alternatively, this can be set globally for the entire edit session using the IWorkspaceEditControl interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canBypassStoreMethod in interface IObjectClassInfo
Specified by:
canBypassStoreMethod in interface IObjectClassInfo2
Returns:
The canBypassStore
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canBypassEditSession

public boolean canBypassEditSession()
                             throws java.io.IOException,
                                    AutomationException
Indicates if updates to objects can be safely made outside of an edit session.

Remarks

CanBypassEditSession is a convenience method that returns True if the instances of this object class may be created or updated outside of a Geodatabase edit session (an edit session is started by using the StartEditing method on the IWorkspaceEdit or the StartMultiuserEditing method on the IMultiuserWorkspaceEdit interface).

If True , then applications may update the data in this object class using any of the data updating interfaces and methods described here without starting an edit session. In this case applications are responsible for starting host database transactions as appropriate and for discarding cached object states across transaction boundaries when running on an ArcSDE database.

If False, then applications should always make modifications to the data in this object class within an edit session for correct multi-user behavior and for correct management of database state internally cached by the Geodatabase for the objects in this object class.

This method returns False for network feature classes. By default, this method returns True for non-network custom object classes. The developer of a non-network custom object class can change this behavior by implementing this interface on the class extension associated with the class and returning true for the method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canBypassEditSession in interface IObjectClassInfo2
Returns:
The canBypassEditSession
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasSubtype

public boolean isHasSubtype()
                     throws java.io.IOException,
                            AutomationException
Indicates if the table has subtypes.

Specified by:
isHasSubtype in interface ISubtypes
Returns:
The hasSubtype
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultSubtypeCode

public int getDefaultSubtypeCode()
                          throws java.io.IOException,
                                 AutomationException
The default subtype associated with the class.

Specified by:
getDefaultSubtypeCode in interface ISubtypes
Returns:
The subtypeCode
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultSubtypeCode

public void setDefaultSubtypeCode(int subtypeCode)
                           throws java.io.IOException,
                                  AutomationException
The default subtype associated with the class.

Specified by:
setDefaultSubtypeCode in interface ISubtypes
Parameters:
subtypeCode - The subtypeCode (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultValue

public java.lang.Object getDefaultValue(int subtypeCode,
                                        java.lang.String fieldName)
                                 throws java.io.IOException,
                                        AutomationException
The default value for the associated attribute.

Specified by:
getDefaultValue in interface ISubtypes
Parameters:
subtypeCode - The subtypeCode (in)
fieldName - The fieldName (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultValue

public void setDefaultValue(int subtypeCode,
                            java.lang.String fieldName,
                            java.lang.Object value)
                     throws java.io.IOException,
                            AutomationException
The default value for the associated attribute.

Specified by:
setDefaultValue in interface ISubtypes
Parameters:
subtypeCode - The subtypeCode (in)
fieldName - The fieldName (in)
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDomain

public IDomain getDomain(int subtypeCode,
                         java.lang.String fieldName)
                  throws java.io.IOException,
                         AutomationException
The domain given the subtype and field.

Specified by:
getDomain in interface ISubtypes
Parameters:
subtypeCode - The subtypeCode (in)
fieldName - The fieldName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDomain
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDomainByRef

public void setDomainByRef(int subtypeCode,
                           java.lang.String fieldName,
                           IDomain domain)
                    throws java.io.IOException,
                           AutomationException
The domain given the subtype and field.

Specified by:
setDomainByRef in interface ISubtypes
Parameters:
subtypeCode - The subtypeCode (in)
fieldName - The fieldName (in)
domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubtypeFieldName

public java.lang.String getSubtypeFieldName()
                                     throws java.io.IOException,
                                            AutomationException
The subtype field name.

Specified by:
getSubtypeFieldName in interface ISubtypes
Returns:
The fieldName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubtypeFieldName

public void setSubtypeFieldName(java.lang.String fieldName)
                         throws java.io.IOException,
                                AutomationException
The subtype field name.

Specified by:
setSubtypeFieldName in interface ISubtypes
Parameters:
fieldName - The fieldName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubtypeFieldIndex

public int getSubtypeFieldIndex()
                         throws java.io.IOException,
                                AutomationException
The subtype field index.

Specified by:
getSubtypeFieldIndex in interface ISubtypes
Returns:
The index
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubtypeName

public java.lang.String getSubtypeName(int subtypeCode)
                                throws java.io.IOException,
                                       AutomationException
The subtype name.

Specified by:
getSubtypeName in interface ISubtypes
Parameters:
subtypeCode - The subtypeCode (in)
Returns:
The subtypeName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubtypes

public IEnumSubtype getSubtypes()
                         throws java.io.IOException,
                                AutomationException
The subtypes associated with the class.

Specified by:
getSubtypes in interface ISubtypes
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumSubtype
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addSubtype

public void addSubtype(int subtypeCode,
                       java.lang.String subtypeName)
                throws java.io.IOException,
                       AutomationException
Adds the subtype to the set of associated subtypes.

Specified by:
addSubtype in interface ISubtypes
Parameters:
subtypeCode - The subtypeCode (in)
subtypeName - The subtypeName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteSubtype

public void deleteSubtype(int subtypeCode)
                   throws java.io.IOException,
                          AutomationException
Deletes the subtype from the set of associated subtypes.

Specified by:
deleteSubtype in interface ISubtypes
Parameters:
subtypeCode - The subtypeCode (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRules

public IEnumRule getRules()
                   throws java.io.IOException,
                          AutomationException
The rules associated with the class.

Specified by:
getRules in interface IValidation
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRulesByField

public IEnumRule getRulesByField(java.lang.String fieldName)
                          throws java.io.IOException,
                                 AutomationException
The rules associated with the attribute.

Specified by:
getRulesByField in interface IValidation
Parameters:
fieldName - The fieldName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRulesBySubtypeCode

public IEnumRule getRulesBySubtypeCode(int subtypeCode)
                                throws java.io.IOException,
                                       AutomationException
The rules associated with the subtype.

Specified by:
getRulesBySubtypeCode in interface IValidation
Parameters:
subtypeCode - The subtypeCode (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addRule

public void addRule(IRule rule)
             throws java.io.IOException,
                    AutomationException
Adds the rule to the set of associated rules.

Specified by:
addRule in interface IValidation
Parameters:
rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteRule

public void deleteRule(IRule rule)
                throws java.io.IOException,
                       AutomationException
Deletes the rule from the set of associated rules.

Specified by:
deleteRule in interface IValidation
Parameters:
rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validate

public ISelectionSet validate(IQueryFilter selection,
                              IWorkspace workspace)
                       throws java.io.IOException,
                              AutomationException
Validates the selection.

Specified by:
validate in interface IValidation
Parameters:
selection - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validateSelection

public ISelectionSet validateSelection(ISelectionSet selection,
                                       IWorkspace workspace)
                                throws java.io.IOException,
                                       AutomationException
Validates the selection.

Specified by:
validateSelection in interface IValidation
Parameters:
selection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validateSet

public ISet validateSet(ISet selection)
                 throws java.io.IOException,
                        AutomationException
Validates the set.

Specified by:
validateSet in interface IValidation
Parameters:
selection - A reference to a com.esri.arcgis.system.ISet (in)
Returns:
A reference to a com.esri.arcgis.system.ISet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterRule

public void alterRule(IRule rule)
               throws java.io.IOException,
                      AutomationException
Alter the existing validation rule.

Specified by:
alterRule in interface IValidation2
Parameters:
rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException
The PropertySet containing metadata.

Specified by:
getMetadata in interface IMetadata
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet propertySet)
                 throws java.io.IOException,
                        AutomationException
The PropertySet containing metadata.

Specified by:
setMetadata in interface IMetadata
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException
Updates metadata with the current properties; may create metadata if it doesn't already exist.

Specified by:
synchronize in interface IMetadata
Parameters:
action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)
interval - The interval (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws java.io.IOException,
                                 AutomationException
Indicates if metadata can be edited.

Specified by:
isCanEditMetadata in interface IMetadataEdit
Returns:
The canEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicElementAssociations

public IEnumSchematicElementAssociation getSchematicElementAssociations()
                                                                 throws java.io.IOException,
                                                                        AutomationException
Schematic element associations enumeration within the container.

Specified by:
getSchematicElementAssociations in interface ISchematicElementAssociationContainer
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicElementAssociation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicElementAssociationByID

public ISchematicElementAssociation getSchematicElementAssociationByID(int iD)
                                                                throws java.io.IOException,
                                                                       AutomationException
Schematic element association referenced by the specified ID.

Specified by:
getSchematicElementAssociationByID in interface ISchematicElementAssociationContainer
Parameters:
iD - The iD (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElementAssociation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicElementClasses

public IEnumSchematicElementClass getSchematicElementClasses()
                                                      throws java.io.IOException,
                                                             AutomationException
Schematic element classes enumeration within the schematic element class container.

Specified by:
getSchematicElementClasses in interface ISchematicElementClassContainer
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicElementClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicElementClass

public ISchematicElementClass getSchematicElementClass(java.lang.String name)
                                                throws java.io.IOException,
                                                       AutomationException
Schematic diagram class referenced by the specified Name.

Specified by:
getSchematicElementClass in interface ISchematicElementClassContainer
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElementClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_getClass

public IClass esri_getClass()
                     throws java.io.IOException,
                            AutomationException
The class for this class helper.

Specified by:
esri_getClass in interface IClassHelper
Returns:
A reference to a com.esri.arcgis.geodatabase.IClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicObjectClasses

public IEnumSchematicObjectClass getSchematicObjectClasses()
                                                    throws java.io.IOException,
                                                           AutomationException
Schematic object classes enumeration within the schematic object class container.

Specified by:
getSchematicObjectClasses in interface ISchematicObjectClassContainer
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicObjectClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicObjectClass

public ISchematicObjectClass getSchematicObjectClass(java.lang.String name)
                                              throws java.io.IOException,
                                                     AutomationException
Schematic object class referenced by the specified Name.

Specified by:
getSchematicObjectClass in interface ISchematicObjectClassContainer
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicObjectClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterSchematicAttributeCLSID

public void alterSchematicAttributeCLSID(java.lang.String name,
                                         IUID uID)
                                  throws java.io.IOException,
                                         AutomationException
Changes the schematic attribute CLSID.

Specified by:
alterSchematicAttributeCLSID in interface ISchematicAttributeDesign
Parameters:
name - The name (in)
uID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicAttributes

public IEnumSchematicAttribute getSchematicAttributes()
                                               throws java.io.IOException,
                                                      AutomationException
Schematic attributes enumeration within the schematic attribute container.

Specified by:
getSchematicAttributes in interface ISchematicAttributeContainer
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicAttribute
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicAttribute

public ISchematicAttribute getSchematicAttribute(java.lang.String name,
                                                 boolean recursiveSearch)
                                          throws java.io.IOException,
                                                 AutomationException
Retrives recursively or not the schematic attribute referenced by the specified Name.

Specified by:
getSchematicAttribute in interface ISchematicAttributeContainer
Parameters:
name - The name (in)
recursiveSearch - The recursiveSearch (in, optional, pass false if not required)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicAttribute
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD