com.esri.arcgis.geodatabase
Interface IVersionInfo

All Superinterfaces:

Serializable

All Known Subinterfaces:

IVersionInfo2

All Known Implementing Classes:

IVersionInfoProxy, VersionInfo

public interface IVersionInfo
extends Serializable

Provides access to members that supply version information.

Description

The IVersionInfo interface is a read-only collection of methods used to obtain different properties of a version. If you need to set properties of a version, use the IVersion interface.

Product Availability

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

Method Summary

int	getAccess() The version's access permission.
IEnumVersionInfo	getAncestors() The version's ancestors.
IEnumVersionInfo	getChildren() The version's children.
Object	getCreated() The date and time the version was created.
String	getDescription() The version's description.
Object	getModified() The date and time the version was last modified.
IVersionInfo	getParent() The version's parent.
String	getVersionName() The version's name.
boolean	isOwner() True if the current connected user is the owner of this version.

Method Detail

getVersionName

String getVersionName()
                      throws IOException,
                             AutomationException

The version's name.

Remarks

The VersionName method is used to retrieve a version's name. The name will be qualified with the owner of the version. For example, for a version called "MyWorkOrder" owned by the user "GIS", VersionName will return "GIS.MyWorkOrder"

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

The version's description.

Remarks

The Description method is used to retrieve a version's description.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAccess

int getAccess()
              throws IOException,
                     AutomationException

The version's access permission.

Remarks

The Access method is used to retrieve a version's permission. The permission can be private, public or protected.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.esriVersionAccess constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCreated

Object getCreated()
                  throws IOException,
                         AutomationException

The date and time the version was created.

Remarks

The Created method is used to retrieve the date when the version was created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModified

Object getModified()
                   throws IOException,
                          AutomationException

The date and time the version was last modified.

Remarks

The Modified method is used to retrieve the date when the version was last modified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParent

IVersionInfo getParent()
                       throws IOException,
                              AutomationException

The version's parent.

Remarks

The Parent method is used to retrieve the version's parent version properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

IEnumVersionInfo getChildren()
                             throws IOException,
                                    AutomationException

The version's children.

Remarks

The Children method is used to retrieve an IEnumVersionInfo enumeration of all the version's that were created from the current version. The IEnumVersionInfo enumeration is then used to obtain an IVersionInfo object for the child version.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getAncestors

IEnumVersionInfo getAncestors()
                              throws IOException,
                                     AutomationException

The version's ancestors.

Remarks

The Ancestors method is used to retrieve an IEnumVersionInfo enumeration of all the version's that are in the ancestral lineage for the current version. For example, the parent version, the grandparent version, etc. all the way back to the default version. The IEnumVersionInfo enumeration is then used to obtain an IVersionInfo object for each version.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

isOwner

boolean isOwner()
                throws IOException,
                       AutomationException

True if the current connected user is the owner of this version.

Remarks

The IsOwner method is used to retrieve a boolean value to determine if the currently connected user owns the version.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The isOwner

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.