com.esri.arcgis.carto
Interface IChangeDatabaseVersion

All Superinterfaces:
Serializable
All Known Implementing Classes:
ChangeDatabaseVersion, IChangeDatabaseVersionProxy

public interface IChangeDatabaseVersion
extends Serializable

Provides access to the Change Database Version operation.

Remarks

IChangeDatabaseVersion provides access to the methods and properties of the ChangeDatabaseVersion object. ChangeDatabaseVersion is a coarse grained object that performs the steps needed to change the database version of layers and tables in a Map, Scene, or Globe. IChangeDatabaseVersion contains one method, Execute, which is used to perform the change.

Product Availability

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


Method Summary
 ISet execute(IVersion pFrom, IVersion pTo, IBasicMap pMap)
          Replaces the version of the feature classes for all the layers that belong to the From version to To version.
 

Method Detail

execute

ISet execute(IVersion pFrom,
             IVersion pTo,
             IBasicMap pMap)
             throws IOException,
                    AutomationException
Replaces the version of the feature classes for all the layers that belong to the From version to To version.

Remarks

The Execute method is used to change the version of versioned data from one version to another. The versions can be transactional or historical. The input parameters of this method are:

pFrom: The version to move away from. Only layers with a data source referencing this version will be changed.

pTo: The version to change to.

pMap: An IBasicMap reference, which could be a Map, Globe, or Scene, that contains the layers to be changed.

The return parameter of the method is a set of table and layer references of the layers that had their version changed.

This command fires the following events:

IActiveViewEvents::ContentsChanged when executed on a Map, Scene, or Globe.

Additionally the events IMapEvents::FeatureClassChanged and IMapEvents2::TableChanged are fired for each layer and table respectively when changing the version on a Map.

When executing this method on a Map, you may wish to call IMapAdmin::FireChangeVersion prior to performing the version change to additionally notify listeners of the change.

Product Availability

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

Parameters:
pFrom - A reference to a com.esri.arcgis.geodatabase.IVersion (in)
pTo - A reference to a com.esri.arcgis.geodatabase.IVersion (in)
pMap - A reference to a com.esri.arcgis.carto.IBasicMap (in)
Returns:
A reference to a com.esri.arcgis.system.ISet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.