com.esri.arcgis.geodatabase
Class IVersionInfoProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabase.IVersionInfoProxy
All Implemented Interfaces:
IVersionInfo, Externalizable, Serializable

public class IVersionInfoProxy
extends com.esri.arcgis.interop.Dispatch
implements IVersionInfo, 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.

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
  IVersionInfoProxy()
           
  IVersionInfoProxy(Object obj)
           
protected IVersionInfoProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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.
 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

IVersionInfoProxy

public IVersionInfoProxy()

IVersionInfoProxy

public IVersionInfoProxy(Object obj)
                  throws IOException
Throws:
IOException

IVersionInfoProxy

protected IVersionInfoProxy(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

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.