com.esri.arcgis.geodatabaseextensions
Class DECadastralFabric

java.lang.Object
  extended by com.esri.arcgis.geodatabaseextensions.DECadastralFabric
All Implemented Interfaces:
IDataElement, IDEDataset, IDEGeoDataset, IGPDescribe, IGPValue, IMetadata, IDECadastralFabric, IDECadastralFabric2, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class DECadastralFabric
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDEDataset, IDEGeoDataset, IDECadastralFabric, IDECadastralFabric2, IDataElement, IMetadata, IGPValue, IClone, IXMLSerialize, IPersistStream, IGPDescribe, IDocumentVersionSupportGEN, Externalizable

Cadastral Fabric Data Element object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
DECadastralFabric()
          Constructs a DECadastralFabric using ArcGIS Engine.
DECadastralFabric(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DECadastralFabric theDECadastralFabric = (DECadastralFabric) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 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 getAsText()
          Provides the value of the value object.
 String getBaseName()
          File base name.
 double getBufferDistanceForAdjustment()
          The distance used to generate a buffer around the job parcels.
 IArray getCadastralTableFieldEdits()
          Provides access to the field customizations for the cadastral fabric table.
 String getCatalogPath()
          The string used to retrieve the element.
 IArray getChildren()
          The list of sub-elements.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getCompiledAccuracyCategory()
          The default accuracy category for compiled parcels.
 String getConfigurationKeyword()
          The database configuration keyword for the cadastral fabric.
 int getDatasetType()
          Dataset type.
 int getDefaultAccuracyCategory()
          The default accuracy category for the cadastral fabric.
 int getDSID()
          The id of the dataset.
 String getExtension()
          File extension.
 IEnvelope getExtent()
          The extent of the coverage.
 String getFile()
          File name.
 double getMaximumShiftThreshold()
          Coordinate changes will be written if the shift is greater than this tolerance value.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 String getPath()
          File path.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ISpatialReference getSpatialReference()
          The spatial reference of the geodataset.
 String getSurrogateVersion()
          The name of the surrogate version if applicable.
 int getType()
          The cadastral fabric type.
 int getVersion()
          The cadastral fabric version.
 int hashCode()
          the hashcode for this object
 String IDataElement_getName()
          The user assigned name for the element.
 String IDataElement_getType()
          The type of the element.
 IGPDataType IGPValue_getDataType()
          The data type of the value object.
 boolean isCanVersion()
          Indicates if this dataset can be versioned.
 boolean isChildrenExpanded()
          Indicates if the children have been expanded.
 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 isIdentical(IClone other)
          Indicates if the receiver and other are the same object.
 boolean isMetadataRetrieved()
          Indicates if the metadata has been retrieved.
 boolean isMultiGenerationEditing()
          Indicates whether Cadastral Fabrics greater than one level below default can be edited.
 boolean isMultiLevelReconcile()
          Indicates if reconciling and posting with an ancestor more than one generation above the working version is allowed.
 boolean isPinAdjustmentBoundary()
          Indicates whether points on the adjustment area boundary should be pinned.
 boolean isPinAdjustmentPointsWithinBoundary()
          Indicates whether non-adjusted points within the adjustment are should be pinned.
 boolean isSupportedAtVersion(int docVersion)
          Is this object valid at the given document version.
 boolean isVersioned()
          Indicates if this dataset is versioned.
 boolean isWriteAdjustmentVectors()
          Indicates whether adjustment vectors should be written.
 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.
 IGPMessage setAsText(String text)
          Provides the value of the value object with the given string value.
 void setBufferDistanceForAdjustment(double distance)
          The distance used to generate a buffer around the job parcels.
 void setCadastralTableFieldEditsByRef(IArray cadastralTableFieldEdits)
          Provides access to the field customizations for the cadastral fabric table.
 void setCanVersion(boolean canVersion)
          Indicates if this dataset can be versioned.
 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 setCompiledAccuracyCategory(int defaultAccuracy)
          The default accuracy category for compiled parcels.
 void setConfigurationKeyword(String configKeyword)
          The database configuration keyword for the cadastral fabric.
 void setDatasetType(int type)
          Dataset type.
 void setDefaultAccuracyCategory(int defaultAccuracy)
          The default accuracy category for the cadastral fabric.
 void setDSID(int dSID)
          The id of the dataset.
 void setExtentByRef(IEnvelope extent)
          The extent of the coverage.
 void setFullPropsRetrieved(boolean fullPropsRetrieved)
          Indicates if full properties have been retrieved.
 void setMaximumShiftThreshold(double threshold)
          Coordinate changes will be written if the shift is greater than this tolerance value.
 void setMetadata(IPropertySet ppPropertySet)
          The PropertySet containing metadata.
 void setMetadataRetrieved(boolean metadataRetrieved)
          Indicates if the metadata has been retrieved.
 void setMultiGenerationEditing(boolean pAllow)
          Indicates whether Cadastral Fabrics greater than one level below default can be edited.
 void setMultiLevelReconcile(boolean pAllow)
          Indicates if reconciling and posting with an ancestor more than one generation above the working version is allowed.
 void setName(String name)
          The user assigned name for the element.
 void setPinAdjustmentBoundary(boolean pPinBoundary)
          Indicates whether points on the adjustment area boundary should be pinned.
 void setPinAdjustmentPointsWithinBoundary(boolean pPinWithinBoundary)
          Indicates whether non-adjusted points within the adjustment are should be pinned.
 void setSpatialReferenceByRef(ISpatialReference spatialReference)
          The spatial reference of the geodataset.
 void setSurrogateVersion(String surrogate)
          The name of the surrogate version if applicable.
 void setType(int type)
          The cadastral fabric type.
 void setType(String type)
          The type of the element.
 void setVersioned(boolean versioned)
          Indicates if this dataset is versioned.
 void setWriteAdjustmentVectors(boolean pWriteAdjustmentVectors)
          Indicates whether adjustment vectors should be written.
 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

DECadastralFabric

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

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

DECadastralFabric

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

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

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

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.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The extent of the coverage.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setExtentByRef

public void setExtentByRef(IEnvelope extent)
                    throws IOException,
                           AutomationException
The extent of the coverage.

Product Availability

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

Specified by:
setExtentByRef in interface IDEGeoDataset
Parameters:
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException
The spatial reference of the geodataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialReference)
                              throws IOException,
                                     AutomationException
The spatial reference of the geodataset.

Product Availability

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

Specified by:
setSpatialReferenceByRef in interface IDEGeoDataset
Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConfigurationKeyword

public String getConfigurationKeyword()
                               throws IOException,
                                      AutomationException
The database configuration keyword for the cadastral fabric.

Remarks

Get or put the database configuration keyword for the cadastral fabric.

The optional configurationKeyword parameter allows the application to control the physical layout for this table in the underlying RDBMS—for example, in the case of an Oracle database, the configuration keyword controls the tablespace in which the table is created, the initial and next extents, and other properties. The configurationKeywords for an ArcSDE instance are set up by the ArcSDE data administrator, the list of available keywords supported by a workspace may be obtained using the IWorkspaceConfiguration interface. For more information on configuration keywords, refer to the ArcSDE documentation.

Use the DECadastralFabric object to create a new Cadastral Fabric. To update an existing fabric, pass the updated DECadastralFabric object to the method ICadastralFabricSchemaEdit::UpdateSchema().

Product Availability

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

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

setConfigurationKeyword

public void setConfigurationKeyword(String configKeyword)
                             throws IOException,
                                    AutomationException
The database configuration keyword for the cadastral fabric.

Product Availability

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

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

getDefaultAccuracyCategory

public int getDefaultAccuracyCategory()
                               throws IOException,
                                      AutomationException
The default accuracy category for the cadastral fabric.

Remarks

Get or put the default accuracy category for the cadastral fabric.

The DefaultAccuracy is the default accuracy category used for the cadastral fabric. The default accuracy value is intialized to category 4, by default.

The default accuracy that will be used for cadastral features may be specified on the creation of a cadastral fabric. This value will be applied to new features that do not have an accuracy value explicitly defined. The accuracy values are defined in the cadastral fabric’s accuracy table. The values represent the quality of instruments used at the time the data was collected.

Use the DECadastralFabric object to create a new Cadastral Fabric. To update an existing fabric, pass the updated DECadastralFabric object to the method ICadastralFabricSchemaEdit::UpdateSchema().

Product Availability

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

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

setDefaultAccuracyCategory

public void setDefaultAccuracyCategory(int defaultAccuracy)
                                throws IOException,
                                       AutomationException
The default accuracy category for the cadastral fabric.

Product Availability

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

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

setCadastralTableFieldEditsByRef

public void setCadastralTableFieldEditsByRef(IArray cadastralTableFieldEdits)
                                      throws IOException,
                                             AutomationException
Provides access to the field customizations for the cadastral fabric table.

Product Availability

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

Specified by:
setCadastralTableFieldEditsByRef in interface IDECadastralFabric
Parameters:
cadastralTableFieldEdits - 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.

getCadastralTableFieldEdits

public IArray getCadastralTableFieldEdits()
                                   throws IOException,
                                          AutomationException
Provides access to the field customizations for the cadastral fabric table.

Remarks

The customized field updates for the the cadastral fabric table.

The CadastralTableFieldEdits property provides access to the field customizations for the cadastral fabric table.

Use the DECadastralFabric object to create a new Cadastral Fabric. To update an existing fabric, pass the updated DECadastralFabric object to the method ICadastralFabricSchemaEdit::UpdateSchema().

Product Availability

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

Specified by:
getCadastralTableFieldEdits in interface IDECadastralFabric
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.

getCompiledAccuracyCategory

public int getCompiledAccuracyCategory()
                                throws IOException,
                                       AutomationException
The default accuracy category for compiled parcels.

Product Availability

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

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

setCompiledAccuracyCategory

public void setCompiledAccuracyCategory(int defaultAccuracy)
                                 throws IOException,
                                        AutomationException
The default accuracy category for compiled parcels.

Product Availability

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

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

getBufferDistanceForAdjustment

public double getBufferDistanceForAdjustment()
                                      throws IOException,
                                             AutomationException
The distance used to generate a buffer around the job parcels. This buffer defines the adjustment area.

Product Availability

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

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

setBufferDistanceForAdjustment

public void setBufferDistanceForAdjustment(double distance)
                                    throws IOException,
                                           AutomationException
The distance used to generate a buffer around the job parcels. This buffer defines the adjustment area.

Product Availability

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

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

getType

public int getType()
            throws IOException,
                   AutomationException
The cadastral fabric type.

Product Availability

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

Specified by:
getType in interface IDECadastralFabric2
Returns:
A com.esri.arcgis.geodatabaseextensions.esriCadastralFabricType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int type)
             throws IOException,
                    AutomationException
The cadastral fabric type.

Product Availability

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

Specified by:
setType in interface IDECadastralFabric2
Parameters:
type - A com.esri.arcgis.geodatabaseextensions.esriCadastralFabricType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSurrogateVersion

public String getSurrogateVersion()
                           throws IOException,
                                  AutomationException
The name of the surrogate version if applicable. Indicates if the cadastral fabric is a surrogate version.

Product Availability

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

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

setSurrogateVersion

public void setSurrogateVersion(String surrogate)
                         throws IOException,
                                AutomationException
The name of the surrogate version if applicable. Indicates if the cadastral fabric is a surrogate version.

Product Availability

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

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

getVersion

public int getVersion()
               throws IOException,
                      AutomationException
The cadastral fabric version.

Product Availability

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

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

getMaximumShiftThreshold

public double getMaximumShiftThreshold()
                                throws IOException,
                                       AutomationException
Coordinate changes will be written if the shift is greater than this tolerance value.

Product Availability

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

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

setMaximumShiftThreshold

public void setMaximumShiftThreshold(double threshold)
                              throws IOException,
                                     AutomationException
Coordinate changes will be written if the shift is greater than this tolerance value.

Product Availability

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

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

isMultiGenerationEditing

public boolean isMultiGenerationEditing()
                                 throws IOException,
                                        AutomationException
Indicates whether Cadastral Fabrics greater than one level below default can be edited.

Product Availability

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

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

setMultiGenerationEditing

public void setMultiGenerationEditing(boolean pAllow)
                               throws IOException,
                                      AutomationException
Indicates whether Cadastral Fabrics greater than one level below default can be edited.

Product Availability

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

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

isMultiLevelReconcile

public boolean isMultiLevelReconcile()
                              throws IOException,
                                     AutomationException
Indicates if reconciling and posting with an ancestor more than one generation above the working version is allowed.

Product Availability

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

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

setMultiLevelReconcile

public void setMultiLevelReconcile(boolean pAllow)
                            throws IOException,
                                   AutomationException
Indicates if reconciling and posting with an ancestor more than one generation above the working version is allowed.

Product Availability

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

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

isPinAdjustmentBoundary

public boolean isPinAdjustmentBoundary()
                                throws IOException,
                                       AutomationException
Indicates whether points on the adjustment area boundary should be pinned.

Product Availability

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

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

setPinAdjustmentBoundary

public void setPinAdjustmentBoundary(boolean pPinBoundary)
                              throws IOException,
                                     AutomationException
Indicates whether points on the adjustment area boundary should be pinned.

Product Availability

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

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

isPinAdjustmentPointsWithinBoundary

public boolean isPinAdjustmentPointsWithinBoundary()
                                            throws IOException,
                                                   AutomationException
Indicates whether non-adjusted points within the adjustment are should be pinned.

Product Availability

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

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

setPinAdjustmentPointsWithinBoundary

public void setPinAdjustmentPointsWithinBoundary(boolean pPinWithinBoundary)
                                          throws IOException,
                                                 AutomationException
Indicates whether non-adjusted points within the adjustment are should be pinned.

Product Availability

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

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

isWriteAdjustmentVectors

public boolean isWriteAdjustmentVectors()
                                 throws IOException,
                                        AutomationException
Indicates whether adjustment vectors should be written.

Product Availability

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

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

setWriteAdjustmentVectors

public void setWriteAdjustmentVectors(boolean pWriteAdjustmentVectors)
                               throws IOException,
                                      AutomationException
Indicates whether adjustment vectors should be written.

Product Availability

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

Specified by:
setWriteAdjustmentVectors in interface IDECadastralFabric2
Parameters:
pWriteAdjustmentVectors - The pWriteAdjustmentVectors (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.

IDataElement_getName

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

Product Availability

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

Specified by:
IDataElement_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.

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.

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.

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.

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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException
Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:
isSupportedAtVersion in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException
Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:
convertToSupportedObject in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (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