com.esri.arcgis.editor
Interface IVersionChangesWindow

All Superinterfaces:

Serializable

All Known Implementing Classes:

VersionChangesWindow

public interface IVersionChangesWindow
extends Serializable

Provides access to Version Changes Window.

Description

This interface is new at ArcGIS 9.3.

Product Availability

Available with ArcGIS Desktop.

Method Summary

String	esri_getClass(int index) Class by index.
IObjectClass	findClass(String className, int vers) Finds a cached table corresponding to specified version.
int	getClassCount() The number of classes with changes.
int	getCurrentChangeType() Change Type of the selected row or feature.
String	getCurrentClass() Class name of the selected row or feature.
int	getCurrentRow() ID of the current row or feature.
IEnumIDs	getIDs(String className, int changeType) Enumerate the difference row IDs of the current class.
ILongArray	getSelectedFieldIndexes() The indexes of the fields in the row that are currently selected.
boolean	initialize(int parentHwnd, IMap pMap, IVersion pSourceVersion, IVersion pTargetVersion, IEnvelope pEnvelope, ITrackCancel pTrackCancel) Initialize Version Changes Window.
boolean	isVisible() Indicates if Version Changes Window is visible.
boolean	refreshChanges(ITrackCancel pTrackCancel) Re-Discover changes and re-populate window.
void	setVisible(boolean pVisible) Indicates if Version Changes Window is visible.

Method Detail

initialize

boolean initialize(int parentHwnd,
                   IMap pMap,
                   IVersion pSourceVersion,
                   IVersion pTargetVersion,
                   IEnvelope pEnvelope,
                   ITrackCancel pTrackCancel)
                   throws IOException,
                          AutomationException

Initialize Version Changes Window.

Description

Initializes the dialog finding the changes between versions.

Product Availability

Available with ArcGIS Desktop.

Parameters:

parentHwnd - The parentHwnd (A COM typedef) (in)

pMap - A reference to a com.esri.arcgis.carto.IMap (in)

pSourceVersion - A reference to a com.esri.arcgis.geodatabase.IVersion (in)

pTargetVersion - A reference to a com.esri.arcgis.geodatabase.IVersion (in)

pEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

The pCanceled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshChanges

boolean refreshChanges(ITrackCancel pTrackCancel)
                       throws IOException,
                              AutomationException

Re-Discover changes and re-populate window.

Description

Refreshes the dialog finding the current changes between the two versions referenced by the dialog.

Product Availability

Available with ArcGIS Desktop.

Parameters:

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

The pCanceled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean pVisible)
                throws IOException,
                       AutomationException

Indicates if Version Changes Window is visible.

Product Availability

Available with ArcGIS Desktop.

Parameters:

pVisible - The pVisible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if Version Changes Window is visible.

Product Availability

Available with ArcGIS Desktop.

Returns:

The pVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedFieldIndexes

ILongArray getSelectedFieldIndexes()
                                   throws IOException,
                                          AutomationException

The indexes of the fields in the row that are currently selected.

Description

Index of the selected feautres in the version changes dialog.

Product Availability

Available with ArcGIS Desktop.

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentRow

int getCurrentRow()
                  throws IOException,
                         AutomationException

ID of the current row or feature.

Product Availability

Available with ArcGIS Desktop.

Returns:

The pID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentChangeType

int getCurrentChangeType()
                         throws IOException,
                                AutomationException

Change Type of the selected row or feature.

Product Availability

Available with ArcGIS Desktop.

Returns:

A com.esri.arcgis.editor.esriChangeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentClass

String getCurrentClass()
                       throws IOException,
                              AutomationException

Class name of the selected row or feature.

Product Availability

Available with ArcGIS Desktop.

Returns:

The pClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassCount

int getClassCount()
                  throws IOException,
                         AutomationException

The number of classes with changes.

Description

Count of all the classes with changes between selected versions

Product Availability

Available with ArcGIS Desktop.

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_getClass

String esri_getClass(int index)
                     throws IOException,
                            AutomationException

Class by index.

Product Availability

Available with ArcGIS Desktop.

Parameters:

index - The index (in)

Returns:

The pClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIDs

IEnumIDs getIDs(String className,
                int changeType)
                throws IOException,
                       AutomationException

Enumerate the difference row IDs of the current class.

Product Availability

Available with ArcGIS Desktop.

Parameters:

className - The className (in)

changeType - A com.esri.arcgis.editor.esriChangeType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumIDs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findClass

IObjectClass findClass(String className,
                       int vers)
                       throws IOException,
                              AutomationException

Finds a cached table corresponding to specified version.

Product Availability

Available with ArcGIS Desktop.

Parameters:

className - The className (in)

vers - A com.esri.arcgis.editor.esriChangeVersion constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IObjectClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.