com.esri.arcgis.geodatabase
Class DERelationshipClass

java.lang.Object
  extended by com.esri.arcgis.geodatabase.DERelationshipClass
All Implemented Interfaces:
IDataElement, IDEDataset, IDEDataset2, IDEGdbTable, IDERelationshipClassEx, IDERelationshipClassEx2, IDETable, IGPDescribe, IGPValue, IMetadata, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class DERelationshipClass
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDERelationshipClassEx2, IDETable, IDEGdbTable, IDataElement, IDEDataset2, IMetadata, IGPValue, IXMLSerialize, IClone, IPersistStream, IGPDescribe, Externalizable

Relationship Class Data Element object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
DERelationshipClass()
          Constructs a DERelationshipClass using ArcGIS Engine.
DERelationshipClass(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DERelationshipClass theDERelationshipClass = (DERelationshipClass) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 Object describe(String name)
          The description of the named object.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void empty()
          Clears the value object.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 String getAliasName()
          The alias name for the table.
 String getAsText()
          Provides the value of the value object.
 String getBackwardPathLabel()
          The backward path label for the relationship class.
 String getBaseName()
          File base name.
 int getCardinality()
          The cardinality for the relationship class.
 String getCatalogPath()
          The string used to retrieve the element.
 IArray getChildren()
          The list of sub-elements.
 void getClassID(GUID[] pClassID)
          getClassID
 int getClassKey()
          Class key used for the relationship class (Undefined, ClassID or Class Code).
static String getClsid()
          getClsid.
 String getCLSID()
          The GUID for the COM Class (CoClass) corresponding to instances of the object class represented by the table data element.
 String getConfigurationKeyword()
          Configuration keyword.
 IArray getControllerMemberships()
          The set of controller memberships for the table.
 int getDatasetType()
          Dataset type.
 int getDefaultSubtypeCode()
          The default subtype code.
 IArray getDestinationClassKeys()
          An array with the relationship class keys (IGPRelationshipClassKey) of the destination classes.
 IStringArray getDestinationClassNames()
          The names of the destination classes.
 int getDSID()
          The id of the dataset.
 String getEXTCLSID()
          The GUID for the COM Class (CoClass) corresponding to the class extension of the object class represented by the table data element.
 String getExtension()
          File extension.
 IPropertySet getExtensionProperties()
          The properties for the class extension.
 IFields getFields()
          The list of Fields.
 String getFile()
          File name.
 String getForwardPathLabel()
          The forward path label for the relationship class.
 String getGlobalIDFieldName()
          The name of the GlobalID Field.
 IIndexes getIndexes()
          The list of Indexes.
 int getKeyType()
          Key type for the relationship class (Dual or Single).
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 String getModelName()
          The model name for the table.
 String getName()
          The user assigned name for the element.
 int getNotification()
          The notification direction for the relationship class.
 String getOIDFieldName()
          The name of the OID Field.
 IArray getOriginClassKeys()
          An array with the relationship class keys (IGPRelationshipClassKey) of the origin classes.
 IStringArray getOriginClassNames()
          The names of the origin classes.
 String getPath()
          File path.
 String getRasterFieldName()
          The name of the raster field.
 IStringArray getRelationshipClassNames()
          The names of the Relationship Classes this object class participates in.
 IArray getRelationshipRules()
          The relationship rules that apply to this relationship class.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 String getSubtypeFieldName()
          The name of the Subtype Field.
 IArray getSubtypes()
          The set of Subtypes.
 int hashCode()
          the hashcode for this object
 String IDataElement_getType()
          The type of the element.
 IGPDataType IGPValue_getDataType()
          The data type of the value object.
 boolean isAttachmentRelationship()
          Indicates if the relationship class represents a table attachment.
 boolean isAttributed()
          Indicates if the relationships in this relationship class have attributes.
 boolean isCanVersion()
          Indicates if this dataset can be versioned.
 boolean isChildrenExpanded()
          Indicates if the children have been expanded.
 boolean isComposite()
          Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.
 void isDirty()
          isDirty
 boolean isEmpty()
          Indicates if the value object is empty.
 boolean isEqual(IClone other)
          Indicates if the receiver and other have the same properties.
 boolean isFullPropsRetrieved()
          Indicates if full properties have been retrieved.
 boolean isHasGlobalID()
          Indicates if the table has a GlobalID field.
 boolean isHasOID()
          Indicates if the table has an object id field.
 boolean isIdentical(IClone other)
          Indicates if the receiver and other are the same object.
 boolean isMetadataRetrieved()
          Indicates if the metadata has been retrieved.
 boolean isReflexive()
          Indicates if origin and destination sets intersect.
 boolean isVersioned()
          Indicates if this dataset is versioned.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAliasName(String aliasName)
          The alias name for the table.
 IGPMessage setAsText(String text)
          Provides the value of the value object with the given string value.
 void setBackwardPathLabel(String label)
          The backward path label for the relationship class.
 void setCanVersion(boolean canVersion)
          Indicates if this dataset can be versioned.
 void setCardinality(int relCardinality)
          The cardinality for the relationship class.
 void setCatalogPath(String path)
          The string used to retrieve the element.
 void setChildrenByRef(IArray dataElements)
          The list of sub-elements.
 void setChildrenExpanded(boolean childrenExpanded)
          Indicates if the children have been expanded.
 void setClassKey(int classKey)
          Class key used for the relationship class (Undefined, ClassID or Class Code).
 void setCLSID(String classID)
          The GUID for the COM Class (CoClass) corresponding to instances of the object class represented by the table data element.
 void setConfigurationKeyword(String keyword)
          Configuration keyword.
 void setControllerMembershipsByRef(IArray controllerMemberships)
          The set of controller memberships for the table.
 void setDatasetType(int type)
          Dataset type.
 void setDefaultSubtypeCode(int subtypeCode)
          The default subtype code.
 void setDestinationClassKeysByRef(IArray destinationClassNames)
          An array with the relationship class keys (IGPRelationshipClassKey) of the destination classes.
 void setDestinationClassNamesByRef(IStringArray destinationClassNames)
          The names of the destination classes.
 void setDSID(int dSID)
          The id of the dataset.
 void setEXTCLSID(String classID)
          The GUID for the COM Class (CoClass) corresponding to the class extension of the object class represented by the table data element.
 void setExtensionPropertiesByRef(IPropertySet propertySet)
          The properties for the class extension.
 void setFieldsByRef(IFields fields)
          The list of Fields.
 void setForwardPathLabel(String label)
          The forward path label for the relationship class.
 void setFullPropsRetrieved(boolean fullPropsRetrieved)
          Indicates if full properties have been retrieved.
 void setGlobalIDFieldName(String globalIDFieldName)
          The name of the GlobalID Field.
 void setHasGlobalID(boolean hasGlobalID)
          Indicates if the table has a GlobalID field.
 void setHasOID(boolean hasOID)
          Indicates if the table has an object id field.
 void setIndexesByRef(IIndexes indexes)
          The list of Indexes.
 void setIsAttachmentRelationship(boolean attachment)
          Indicates if the relationship class represents a table attachment.
 void setIsAttributed(boolean attributed)
          Indicates if the relationships in this relationship class have attributes.
 void setIsComposite(boolean composite)
          Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.
 void setIsReflexive(boolean reflexive)
          Indicates if origin and destination sets intersect.
 void setKeyType(int keyType)
          Key type for the relationship class (Dual or Single).
 void setMetadata(IPropertySet ppPropertySet)
          The PropertySet containing metadata.
 void setMetadataRetrieved(boolean metadataRetrieved)
          Indicates if the metadata has been retrieved.
 void setModelName(String modelName)
          The model name for the table.
 void setName(String name)
          The user assigned name for the element.
 void setNotification(int notification)
          The notification direction for the relationship class.
 void setOIDFieldName(String oIDFieldName)
          The name of the OID Field.
 void setOriginClassKeysByRef(IArray originClassKeys)
          An array with the relationship class keys (IGPRelationshipClassKey) of the origin classes.
 void setOriginClassNamesByRef(IStringArray originClassNames)
          The names of the origin classes.
 void setRasterFieldName(String fieldName)
          The name of the raster field.
 void setRelationshipClassNamesByRef(IStringArray relationshipClassNames)
          The names of the Relationship Classes this object class participates in.
 void setRelationshipRulesByRef(IArray rules)
          The relationship rules that apply to this relationship class.
 void setSubtypeFieldName(String fieldName)
          The name of the Subtype Field.
 void setSubtypesByRef(IArray subtypes)
          The set of Subtypes.
 void setType(String type)
          The type of the element.
 void setVersioned(boolean versioned)
          Indicates if this dataset is versioned.
 void synchronize(int action, int interval)
          Updates metadata with the current properties; may create metadata if it doesn't already exist.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

DERelationshipClass

public DERelationshipClass()
                    throws IOException,
                           UnknownHostException
Constructs a DERelationshipClass using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

DERelationshipClass

public DERelationshipClass(Object obj)
                    throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DERelationshipClass theDERelationshipClass = (DERelationshipClass) obj;

Construct a DERelationshipClass using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DERelationshipClass.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

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

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

isAttachmentRelationship

public boolean isAttachmentRelationship()
                                 throws IOException,
                                        AutomationException
Indicates if the relationship class represents a table attachment.

Product Availability

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

Specified by:
isAttachmentRelationship in interface IDERelationshipClassEx2
Returns:
The attachment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsAttachmentRelationship

public void setIsAttachmentRelationship(boolean attachment)
                                 throws IOException,
                                        AutomationException
Indicates if the relationship class represents a table attachment.

Product Availability

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

Specified by:
setIsAttachmentRelationship in interface IDERelationshipClassEx2
Parameters:
attachment - The attachment (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOriginClassNames

public IStringArray getOriginClassNames()
                                 throws IOException,
                                        AutomationException
The names of the origin classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOriginClassNames in interface IDERelationshipClassEx
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOriginClassNamesByRef

public void setOriginClassNamesByRef(IStringArray originClassNames)
                              throws IOException,
                                     AutomationException
The names of the origin classes.

Product Availability

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

Specified by:
setOriginClassNamesByRef in interface IDERelationshipClassEx
Parameters:
originClassNames - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDestinationClassNames

public IStringArray getDestinationClassNames()
                                      throws IOException,
                                             AutomationException
The names of the destination classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDestinationClassNames in interface IDERelationshipClassEx
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDestinationClassNamesByRef

public void setDestinationClassNamesByRef(IStringArray destinationClassNames)
                                   throws IOException,
                                          AutomationException
The names of the destination classes.

Product Availability

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

Specified by:
setDestinationClassNamesByRef in interface IDERelationshipClassEx
Parameters:
destinationClassNames - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOriginClassKeys

public IArray getOriginClassKeys()
                          throws IOException,
                                 AutomationException
An array with the relationship class keys (IGPRelationshipClassKey) of the origin classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOriginClassKeys in interface IDERelationshipClassEx
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOriginClassKeysByRef

public void setOriginClassKeysByRef(IArray originClassKeys)
                             throws IOException,
                                    AutomationException
An array with the relationship class keys (IGPRelationshipClassKey) of the origin classes.

Product Availability

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

Specified by:
setOriginClassKeysByRef in interface IDERelationshipClassEx
Parameters:
originClassKeys - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDestinationClassKeys

public IArray getDestinationClassKeys()
                               throws IOException,
                                      AutomationException
An array with the relationship class keys (IGPRelationshipClassKey) of the destination classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDestinationClassKeys in interface IDERelationshipClassEx
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDestinationClassKeysByRef

public void setDestinationClassKeysByRef(IArray destinationClassNames)
                                  throws IOException,
                                         AutomationException
An array with the relationship class keys (IGPRelationshipClassKey) of the destination classes.

Product Availability

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

Specified by:
setDestinationClassKeysByRef in interface IDERelationshipClassEx
Parameters:
destinationClassNames - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeyType

public int getKeyType()
               throws IOException,
                      AutomationException
Key type for the relationship class (Dual or Single).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setKeyType

public void setKeyType(int keyType)
                throws IOException,
                       AutomationException
Key type for the relationship class (Dual or Single).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setKeyType in interface IDERelationshipClassEx
Parameters:
keyType - A com.esri.arcgis.geodatabase.esriRelKeyType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassKey

public int getClassKey()
                throws IOException,
                       AutomationException
Class key used for the relationship class (Undefined, ClassID or Class Code).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setClassKey

public void setClassKey(int classKey)
                 throws IOException,
                        AutomationException
Class key used for the relationship class (Undefined, ClassID or Class Code).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setClassKey in interface IDERelationshipClassEx
Parameters:
classKey - A com.esri.arcgis.geodatabase.esriRelClassKey constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReflexive

public boolean isReflexive()
                    throws IOException,
                           AutomationException
Indicates if origin and destination sets intersect.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isReflexive in interface IDERelationshipClassEx
Returns:
The reflexive
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsReflexive

public void setIsReflexive(boolean reflexive)
                    throws IOException,
                           AutomationException
Indicates if origin and destination sets intersect.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsReflexive in interface IDERelationshipClassEx
Parameters:
reflexive - The reflexive (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getForwardPathLabel

public String getForwardPathLabel()
                           throws IOException,
                                  AutomationException
The forward path label for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getForwardPathLabel in interface IDERelationshipClassEx
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setForwardPathLabel

public void setForwardPathLabel(String label)
                         throws IOException,
                                AutomationException
The forward path label for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setForwardPathLabel in interface IDERelationshipClassEx
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackwardPathLabel

public String getBackwardPathLabel()
                            throws IOException,
                                   AutomationException
The backward path label for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBackwardPathLabel in interface IDERelationshipClassEx
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackwardPathLabel

public void setBackwardPathLabel(String label)
                          throws IOException,
                                 AutomationException
The backward path label for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBackwardPathLabel in interface IDERelationshipClassEx
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCardinality

public int getCardinality()
                   throws IOException,
                          AutomationException
The cardinality for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCardinality

public void setCardinality(int relCardinality)
                    throws IOException,
                           AutomationException
The cardinality for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCardinality in interface IDERelationshipClassEx
Parameters:
relCardinality - A com.esri.arcgis.geodatabase.esriRelCardinality constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNotification

public int getNotification()
                    throws IOException,
                           AutomationException
The notification direction for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setNotification

public void setNotification(int notification)
                     throws IOException,
                            AutomationException
The notification direction for the relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setNotification in interface IDERelationshipClassEx
Parameters:
notification - A com.esri.arcgis.geodatabase.esriRelNotification constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAttributed

public boolean isAttributed()
                     throws IOException,
                            AutomationException
Indicates if the relationships in this relationship class have attributes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isAttributed in interface IDERelationshipClassEx
Returns:
The attributed
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsAttributed

public void setIsAttributed(boolean attributed)
                     throws IOException,
                            AutomationException
Indicates if the relationships in this relationship class have attributes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsAttributed in interface IDERelationshipClassEx
Parameters:
attributed - The attributed (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isComposite

public boolean isComposite()
                    throws IOException,
                           AutomationException
Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isComposite in interface IDERelationshipClassEx
Returns:
The composite
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsComposite

public void setIsComposite(boolean composite)
                    throws IOException,
                           AutomationException
Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsComposite in interface IDERelationshipClassEx
Parameters:
composite - The composite (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelationshipRules

public IArray getRelationshipRules()
                            throws IOException,
                                   AutomationException
The relationship rules that apply to this relationship class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRelationshipRules in interface IDERelationshipClassEx
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelationshipRulesByRef

public void setRelationshipRulesByRef(IArray rules)
                               throws IOException,
                                      AutomationException
The relationship rules that apply to this relationship class.

Product Availability

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

Specified by:
setRelationshipRulesByRef in interface IDERelationshipClassEx
Parameters:
rules - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws IOException,
                        AutomationException
Indicates if the table has an object id field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setHasOID

public void setHasOID(boolean hasOID)
               throws IOException,
                      AutomationException
Indicates if the table has an object id field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setHasOID in interface IDETable
Parameters:
hasOID - The hasOID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

public String getOIDFieldName()
                       throws IOException,
                              AutomationException
The name of the OID Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOIDFieldName

public void setOIDFieldName(String oIDFieldName)
                     throws IOException,
                            AutomationException
The name of the OID Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setOIDFieldName in interface IDETable
Parameters:
oIDFieldName - The oIDFieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIndexes

public IIndexes getIndexes()
                    throws IOException,
                           AutomationException
The list of Indexes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setIndexesByRef

public void setIndexesByRef(IIndexes indexes)
                     throws IOException,
                            AutomationException
The list of Indexes.

Product Availability

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

Specified by:
setIndexesByRef in interface IDETable
Parameters:
indexes - A reference to a com.esri.arcgis.geodatabase.IIndexes (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException
The list of Fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFieldsByRef

public void setFieldsByRef(IFields fields)
                    throws IOException,
                           AutomationException
The list of Fields.

Product Availability

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

Specified by:
setFieldsByRef in interface IDETable
Parameters:
fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCLSID

public String getCLSID()
                throws IOException,
                       AutomationException
The GUID for the COM Class (CoClass) corresponding to instances of the object class represented by the table data element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCLSID in interface IDEGdbTable
Returns:
The classID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCLSID

public void setCLSID(String classID)
              throws IOException,
                     AutomationException
The GUID for the COM Class (CoClass) corresponding to instances of the object class represented by the table data element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCLSID in interface IDEGdbTable
Parameters:
classID - The classID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

public String getEXTCLSID()
                   throws IOException,
                          AutomationException
The GUID for the COM Class (CoClass) corresponding to the class extension of the object class represented by the table data element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEXTCLSID in interface IDEGdbTable
Returns:
The classID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEXTCLSID

public void setEXTCLSID(String classID)
                 throws IOException,
                        AutomationException
The GUID for the COM Class (CoClass) corresponding to the class extension of the object class represented by the table data element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setEXTCLSID in interface IDEGdbTable
Parameters:
classID - The classID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

public IPropertySet getExtensionProperties()
                                    throws IOException,
                                           AutomationException
The properties for the class extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setExtensionPropertiesByRef

public void setExtensionPropertiesByRef(IPropertySet propertySet)
                                 throws IOException,
                                        AutomationException
The properties for the class extension.

Product Availability

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

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

getSubtypeFieldName

public String getSubtypeFieldName()
                           throws IOException,
                                  AutomationException
The name of the Subtype Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSubtypeFieldName

public void setSubtypeFieldName(String fieldName)
                         throws IOException,
                                AutomationException
The name of the Subtype Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDefaultSubtypeCode

public int getDefaultSubtypeCode()
                          throws IOException,
                                 AutomationException
The default subtype code.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDefaultSubtypeCode

public void setDefaultSubtypeCode(int subtypeCode)
                           throws IOException,
                                  AutomationException
The default subtype code.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSubtypes

public IArray getSubtypes()
                   throws IOException,
                          AutomationException
The set of Subtypes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSubtypes in interface IDEGdbTable
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubtypesByRef

public void setSubtypesByRef(IArray subtypes)
                      throws IOException,
                             AutomationException
The set of Subtypes.

Product Availability

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

Specified by:
setSubtypesByRef in interface IDEGdbTable
Parameters:
subtypes - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAliasName

public String getAliasName()
                    throws IOException,
                           AutomationException
The alias name for the table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAliasName

public void setAliasName(String aliasName)
                  throws IOException,
                         AutomationException
The alias name for the table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAliasName in interface IDEGdbTable
Parameters:
aliasName - The aliasName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getModelName

public String getModelName()
                    throws IOException,
                           AutomationException
The model name for the table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setModelName

public void setModelName(String modelName)
                  throws IOException,
                         AutomationException
The model name for the table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getRelationshipClassNames

public IStringArray getRelationshipClassNames()
                                       throws IOException,
                                              AutomationException
The names of the Relationship Classes this object class participates in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRelationshipClassNames in interface IDEGdbTable
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelationshipClassNamesByRef

public void setRelationshipClassNamesByRef(IStringArray relationshipClassNames)
                                    throws IOException,
                                           AutomationException
The names of the Relationship Classes this object class participates in.

Product Availability

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

Specified by:
setRelationshipClassNamesByRef in interface IDEGdbTable
Parameters:
relationshipClassNames - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getControllerMemberships

public IArray getControllerMemberships()
                                throws IOException,
                                       AutomationException
The set of controller memberships for the table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getControllerMemberships in interface IDEGdbTable
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setControllerMembershipsByRef

public void setControllerMembershipsByRef(IArray controllerMemberships)
                                   throws IOException,
                                          AutomationException
The set of controller memberships for the table.

Product Availability

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

Specified by:
setControllerMembershipsByRef in interface IDEGdbTable
Parameters:
controllerMemberships - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasGlobalID

public boolean isHasGlobalID()
                      throws IOException,
                             AutomationException
Indicates if the table has a GlobalID field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isHasGlobalID in interface IDEGdbTable
Returns:
The hasGlobalID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHasGlobalID

public void setHasGlobalID(boolean hasGlobalID)
                    throws IOException,
                           AutomationException
Indicates if the table has a GlobalID field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setHasGlobalID in interface IDEGdbTable
Parameters:
hasGlobalID - The hasGlobalID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGlobalIDFieldName

public String getGlobalIDFieldName()
                            throws IOException,
                                   AutomationException
The name of the GlobalID Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGlobalIDFieldName in interface IDEGdbTable
Returns:
The globalIDFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGlobalIDFieldName

public void setGlobalIDFieldName(String globalIDFieldName)
                          throws IOException,
                                 AutomationException
The name of the GlobalID Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGlobalIDFieldName in interface IDEGdbTable
Parameters:
globalIDFieldName - The globalIDFieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterFieldName

public String getRasterFieldName()
                          throws IOException,
                                 AutomationException
The name of the raster field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setRasterFieldName

public void setRasterFieldName(String fieldName)
                        throws IOException,
                               AutomationException
The name of the raster field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

IDataElement_getType

public String IDataElement_getType()
                            throws IOException,
                                   AutomationException
The type of the element.

Product Availability

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

Specified by:
IDataElement_getType in interface IDataElement
Returns:
The type
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setType

public void setType(String type)
             throws IOException,
                    AutomationException
The type of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setType in interface IDataElement
Parameters:
type - The type (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The user assigned name for the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setName

public void setName(String name)
             throws IOException,
                    AutomationException
The user assigned name for the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCatalogPath

public String getCatalogPath()
                      throws IOException,
                             AutomationException
The string used to retrieve the element.

Remarks

The CatalogPath of a data element contains the path to the dataset. If retrieved from GxObject, the data element's catalog path will correspond to the path displayed by ArcCatalog when the dataset is selected in the view pane. If retrieved from the workspace, the catalog path will be built by following this pattern:
/V=[version]/DatasetKeyword=datasetName/ChildDatasetKeyword=datasetName
The version can be empty if the source is a local geodatabase. The following table shows the dataset types and their respective keywords:
Dataset Type Keyword
Feature dataset FD
Feature class FC
Object class OC
Relationship class RC
Geometric network GN
Topology TOPO
Raster band RB
Raster dataset RD
Raster catalog RCAT
Toolbox TB

The following are sample catalog paths:

/FD=USA/FC=Capitals
/V=SDE.DEFAULT/FD=Landbase/FC=Parcels

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCatalogPath in interface IDataElement
Returns:
The path
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCatalogPath

public void setCatalogPath(String path)
                    throws IOException,
                           AutomationException
The string used to retrieve the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCatalogPath in interface IDataElement
Parameters:
path - The path (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChildren

public IArray getChildren()
                   throws IOException,
                          AutomationException
The list of sub-elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getChildren in interface IDataElement
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setChildrenByRef

public void setChildrenByRef(IArray dataElements)
                      throws IOException,
                             AutomationException
The list of sub-elements.

Product Availability

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

Specified by:
setChildrenByRef in interface IDataElement
Parameters:
dataElements - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isChildrenExpanded

public boolean isChildrenExpanded()
                           throws IOException,
                                  AutomationException
Indicates if the children have been expanded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isChildrenExpanded in interface IDataElement
Returns:
The childrenExpanded
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setChildrenExpanded

public void setChildrenExpanded(boolean childrenExpanded)
                         throws IOException,
                                AutomationException
Indicates if the children have been expanded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setChildrenExpanded in interface IDataElement
Parameters:
childrenExpanded - The childrenExpanded (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMetadataRetrieved

public boolean isMetadataRetrieved()
                            throws IOException,
                                   AutomationException
Indicates if the metadata has been retrieved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isMetadataRetrieved in interface IDataElement
Returns:
The metadataRetrieved
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMetadataRetrieved

public void setMetadataRetrieved(boolean metadataRetrieved)
                          throws IOException,
                                 AutomationException
Indicates if the metadata has been retrieved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMetadataRetrieved in interface IDataElement
Parameters:
metadataRetrieved - The metadataRetrieved (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFullPropsRetrieved

public boolean isFullPropsRetrieved()
                             throws IOException,
                                    AutomationException
Indicates if full properties have been retrieved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isFullPropsRetrieved in interface IDataElement
Returns:
The fullPropsRetrieved
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFullPropsRetrieved

public void setFullPropsRetrieved(boolean fullPropsRetrieved)
                           throws IOException,
                                  AutomationException
Indicates if full properties have been retrieved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFullPropsRetrieved in interface IDataElement
Parameters:
fullPropsRetrieved - The fullPropsRetrieved (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPath

public String getPath()
               throws IOException,
                      AutomationException
File path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPath in interface IDataElement
Returns:
The path
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFile

public String getFile()
               throws IOException,
                      AutomationException
File name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFile in interface IDataElement
Returns:
The file
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBaseName

public String getBaseName()
                   throws IOException,
                          AutomationException
File base name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBaseName in interface IDataElement
Returns:
The baseName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtension

public String getExtension()
                    throws IOException,
                           AutomationException
File extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtension in interface IDataElement
Returns:
The extension
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConfigurationKeyword

public String getConfigurationKeyword()
                               throws IOException,
                                      AutomationException
Configuration keyword.

Product Availability

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

Specified by:
getConfigurationKeyword in interface IDEDataset2
Returns:
The keyword
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConfigurationKeyword

public void setConfigurationKeyword(String keyword)
                             throws IOException,
                                    AutomationException
Configuration keyword.

Product Availability

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

Specified by:
setConfigurationKeyword in interface IDEDataset2
Parameters:
keyword - The keyword (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDatasetType

public int getDatasetType()
                   throws IOException,
                          AutomationException
Dataset type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDatasetType

public void setDatasetType(int type)
                    throws IOException,
                           AutomationException
Dataset type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDatasetType in interface IDEDataset
Parameters:
type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVersioned

public boolean isVersioned()
                    throws IOException,
                           AutomationException
Indicates if this dataset is versioned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isVersioned in interface IDEDataset
Returns:
The versioned
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVersioned

public void setVersioned(boolean versioned)
                  throws IOException,
                         AutomationException
Indicates if this dataset is versioned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVersioned in interface IDEDataset
Parameters:
versioned - The versioned (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDSID

public int getDSID()
            throws IOException,
                   AutomationException
The id of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDSID in interface IDEDataset
Returns:
The dSID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDSID

public void setDSID(int dSID)
             throws IOException,
                    AutomationException
The id of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDSID in interface IDEDataset
Parameters:
dSID - The dSID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanVersion

public boolean isCanVersion()
                     throws IOException,
                            AutomationException
Indicates if this dataset can be versioned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanVersion in interface IDEDataset
Returns:
The canVersion
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCanVersion

public void setCanVersion(boolean canVersion)
                   throws IOException,
                          AutomationException
Indicates if this dataset can be versioned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCanVersion in interface IDEDataset
Parameters:
canVersion - The canVersion (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetadata

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

Remarks

The variable to hold the data must be of IPropertySet data type.

The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMetadata

public void setMetadata(IPropertySet ppPropertySet)
                 throws IOException,
                        AutomationException
The PropertySet containing metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

synchronize

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

Description

The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.

Remarks

The following actions will result in synchronization given each of the listed conditions:

Action Metadata status Esri/Sync element Interval parameter
esriMSAAccessed Doesn't matter Must not be FALSE Must be less than actual interval
esriMSAAlways Doesn't matter Doesn't matter Doesn't matter
esriMSACreated Must not exist Must not be FALSE Must be less than actual interval
esriMSANotCreated Must exist Must not be FALSE Must be less than actual interval
esriMSAOverwrite Doesn't matter Doesn't matter Doesn't matter

The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws IOException,
                                        AutomationException
The data type of the value object.

Product Availability

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

Specified by:
IGPValue_getDataType in interface IGPValue
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPDataType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException
Indicates if the value object is empty.

Remarks

The IsEmpty method returns if this Value object has been set or not.

Product Availability

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

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

empty

public void empty()
           throws IOException,
                  AutomationException
Clears the value object.

Remarks

The Empty method clears this Value object and releases any associated objects.

Product Availability

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

Specified by:
empty in interface IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText()
                 throws IOException,
                        AutomationException
Provides the value of the value object.

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

Product Availability

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

Specified by:
getAsText in interface IGPValue
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException
Provides the value of the value object with the given string value.

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Product Availability

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

Specified by:
setAsText in interface IGPValue
Parameters:
text - The text (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

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

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

describe

public Object describe(String name)
                throws IOException,
                       AutomationException
The description of the named object.

Product Availability

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

Specified by:
describe in interface IGPDescribe
Parameters:
name - The name (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException