com.esri.arcgis.geodatabase
Class IWorkspaceStatusProxy

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

All Implemented Interfaces:

IWorkspaceStatus, Externalizable, Serializable

public class IWorkspaceStatusProxy
extends com.esri.arcgis.interop.Dispatch
implements IWorkspaceStatus, Serializable

Describes the status of a workspace.

Remarks

The IWorkspaceFactoryStatus::WorkspaceStatus property returns an enumeration of IWorkspaceStatus objects for all currently open workspaces. This property should be used as a course grained object to determine the current status of the workspace connection (esriWCSUp or esriWCSDown). Use IWorkspaceStatus::ConnectionStatus property to determine the status of a particular workspace. The values of esriWorkspaceConnectionStatus returned by the IWorkspaceFactoryStatus::WorkspaceStatus property are:

· esriWCSUp indicates that the workspace is up.

· esriWCSDown indicates that the workspace has lost its connection.

If the status of a workspace connection is esriWCSDown a reconnection can be made to the workspace once the workspace becomes available for reconnection. It is recommended to use the IWorkspaceFactoryStatus::PingWorkspaceStatus method to obtain the current status of the down workspace. If the connection status has changed from esriWCSDown to esriWCSAvailable the IWorkspaceFactoryStatus::OpenAvailableWorkspace method can be used to get a reference to the workspace.

Note that IWorkspaceFactoryStatus::OpenAvailableWorkspace does not repair the original workspace, but provides a mechanism to get a new one when reconnection is possible. It is the responsibility of the application to refresh other objects that rely on the new workspace (for example, opening a feature class from the new workspace and setting it into a feature layer).

Product Availability

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

See Also:

Serialized Form

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getConnectionStatus() The current connection status of the workspace.
IWorkspace	getWorkspace() The workspace this status refers to.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	writeExternal(ObjectOutput out)

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, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

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

Constructor Detail

IWorkspaceStatusProxy

public IWorkspaceStatusProxy()

IWorkspaceStatusProxy

public IWorkspaceStatusProxy(Object obj)
                      throws IOException

Throws:

IOException

IWorkspaceStatusProxy

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

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The workspace this status refers to.

Product Availability

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

Specified by:

getWorkspace in interface IWorkspaceStatus

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionStatus

public int getConnectionStatus()
                        throws IOException,
                               AutomationException

The current connection status of the workspace.

Product Availability

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

Specified by:

getConnectionStatus in interface IWorkspaceStatus

Returns:

A com.esri.arcgis.geodatabase.esriWorkspaceConnectionStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

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

Throws:

IOException

ClassNotFoundException