com.esri.arcgis.geodatabase
Class VersionInfo

java.lang.Object
  com.esri.arcgis.geodatabase.VersionInfo

All Implemented Interfaces:

IVersionInfo, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class VersionInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IVersionInfo

VersionInfo Object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

VersionInfo(Object obj)
Construct a VersionInfo using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
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.
int	hashCode() the hashcode for this object
boolean	isOwner() True if the current connected user is the owner of this version.

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

VersionInfo

public VersionInfo(Object obj)
            throws IOException

Construct a VersionInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to VersionInfo.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
VersionInfo o = (VersionInfo)obj; // will not work

VersionInfo o = new VersionInfo(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems VersionInfo theVersionInfo = (VersionInfo) obj;

Method Detail

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

getVersionName

public 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

Specified by:

getVersionName in interface IVersionInfo

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public 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

Specified by:

getDescription in interface IVersionInfo

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAccess

public 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

Specified by:

getAccess in interface IVersionInfo

Returns:

A com.esri.arcgis.geodatabase.esriVersionAccess constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCreated

public 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

Specified by:

getCreated in interface IVersionInfo

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModified

public 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

Specified by:

getModified in interface IVersionInfo

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParent

public 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

Specified by:

getParent in interface IVersionInfo

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

public 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

Specified by:

getChildren in interface IVersionInfo

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

public 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

Specified by:

getAncestors in interface IVersionInfo

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

public 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

Specified by:

isOwner in interface IVersionInfo

Returns:

The isOwner

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.