com.esri.arcgis.geodatabase
Class IVersionedWorkspaceProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IVersionedWorkspaceProxy

All Implemented Interfaces:

IVersionedWorkspace, Externalizable, Serializable

Direct Known Subclasses:

IVersionedWorkspace2Proxy

public class IVersionedWorkspaceProxy
extends com.esri.arcgis.interop.Dispatch
implements IVersionedWorkspace, Serializable

Provides access to members that manage versions.

Superseded By

IVersionedWorkspace3

Description

A VersionedWorkspace is a workspace that supports versioning. It provides the ability to set the version in which the workspace will reference. It also provides methods to enumerate through all the versions in the database and the ability to compress.

When To Use

The IVersionedWorkspace is the main interface for accessing versions. For example, use its methods to retrieve versions, find versions and create new versions.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IVersionedWorkspaceProxy()
	IVersionedWorkspaceProxy(Object obj)
protected	IVersionedWorkspaceProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	compress() Compresses the database by removing states not referenced by a version.
IVersion	findVersion(String name) Finds a specific version given it's name.
IVersion	getDefaultVersion() The Default version.
IEnumVersionInfo	getVersions() All versions the user owns and those which are public or protected.
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IVersionedWorkspaceProxy

public IVersionedWorkspaceProxy()

IVersionedWorkspaceProxy

public IVersionedWorkspaceProxy(Object obj)
                         throws IOException

Throws:

IOException

IVersionedWorkspaceProxy

protected IVersionedWorkspaceProxy(Object obj,
                                   String iid)
                            throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getVersions

public IEnumVersionInfo getVersions()
                             throws IOException,
                                    AutomationException

All versions the user owns and those which are public or protected.

Remarks

The Versions method will return an enumeration of all versions which the connected user owns and versions owned by other users whose access property is "public".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getVersions in interface IVersionedWorkspace

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultVersion

public IVersion getDefaultVersion()
                           throws IOException,
                                  AutomationException

The Default version.

Remarks

The DEFAULT version is always owned by the ArcSDE administrative user. The version is required by the geodatabase and its access property should remain public or protected.

If it is the application developer's goal to obtain a reference to the DEFAULT version, it is recommended to use the DefaultVersion property as opposed to passing in a literal string to FindVersion method. The DefaultVersion method will always return a IVersion object referencing the default version of the workspace from which the name can be obtained through VersionName property on the IVersionInfo interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultVersion in interface IVersionedWorkspace

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findVersion

public IVersion findVersion(String name)
                     throws IOException,
                            AutomationException

Finds a specific version given it's name.

Remarks

FindVersion returns an IVersion interface which is commonly used to read or set a version's properties. The interface requires a string as input. The value of the string is case sensitive and a version's owner should be prefixed as owner.version. If an owner is not specified, only the versions which the user is connected owns are searched.

If it is the application developer's goal to obtain a reference to the DEFAULT version, it is recommended to use the DefaultVersion property as opposed to passing in a literal string to FindVersion method. The DefaultVersion method will always return a IVersion object referencing the default version of the workspace from which the name can be obtained through VersionName property on the IVersionInfo interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findVersion in interface IVersionedWorkspace

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

compress

public void compress()
              throws IOException,
                     AutomationException

Compresses the database by removing states not referenced by a version.

Remarks

Versioned workspace compression is available using the Compress method. Compressing the versioned workspace will remove those database states not referenced by a version.

Only the ArcSDE administrator user can execute the compress method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

compress in interface IVersionedWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.