com.esri.arcgis.carto
Class GFSReplicationAgent

java.lang.Object
  extended by com.esri.arcgis.carto.GFSReplicationAgent
All Implemented Interfaces:
IGFSReplicationAgent, IConnectionPointContainer, IReplicationAgentCancelControl, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class GFSReplicationAgent
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGFSReplicationAgent, IReplicationAgentCancelControl, ISupportErrorInfo, IConnectionPointContainer

A class used to perform replica operations.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
GFSReplicationAgent()
          Constructs a GFSReplicationAgent using ArcGIS Engine.
GFSReplicationAgent(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GFSReplicationAgent theGFSReplicationAgent = (GFSReplicationAgent) obj;
 
Method Summary
 void addIFeatureProgressListener(IFeatureProgress theListener)
          addIFeatureProgressListener.
 void createReplica(IGraphicFeatureServer srcGFS, IWorkspace destWorkspace, String replicaName, IGFSReplicaDescription desc, IGPReplicaOptions repOptions, String layerFolder)
          Creates a replica pair and returns FeatureLayers.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(Object o)
          Compare this object with another
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
static String getClsid()
          getClsid.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void removeIFeatureProgressListener(IFeatureProgress theListener)
          removeIFeatureProgressListener.
 void setCancelTrackerByRef(ITrackCancel rhs1)
          The cancel tracker to inspect for user cancellations.
 void synchronizeReplica(IGraphicFeatureServer trgGFS, IWorkspace srcWorkspace, String replicaName, int dir)
          Synchronize a feature package replica with graphic feature server replica.
 
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

GFSReplicationAgent

public GFSReplicationAgent()
                    throws IOException,
                           UnknownHostException
Constructs a GFSReplicationAgent using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GFSReplicationAgent

public GFSReplicationAgent(Object obj)
                    throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GFSReplicationAgent theGFSReplicationAgent = (GFSReplicationAgent) obj;

Construct a GFSReplicationAgent using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GFSReplicationAgent.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


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

addIFeatureProgressListener

public void addIFeatureProgressListener(IFeatureProgress theListener)
                                 throws IOException
addIFeatureProgressListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabase.IFeatureProgress interface.
Throws:
IOException - If there are communications problems.

removeIFeatureProgressListener

public void removeIFeatureProgressListener(IFeatureProgress theListener)
                                    throws IOException
removeIFeatureProgressListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabase.IFeatureProgress interface.
Throws:
IOException - If there are communications problems.

createReplica

public void createReplica(IGraphicFeatureServer srcGFS,
                          IWorkspace destWorkspace,
                          String replicaName,
                          IGFSReplicaDescription desc,
                          IGPReplicaOptions repOptions,
                          String layerFolder)
                   throws IOException,
                          AutomationException
Creates a replica pair and returns FeatureLayers.

Product Availability

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

Specified by:
createReplica in interface IGFSReplicationAgent
Parameters:
srcGFS - A reference to a com.esri.arcgis.carto.IGraphicFeatureServer (in)
destWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
replicaName - The replicaName (in)
desc - A reference to a com.esri.arcgis.carto.IGFSReplicaDescription (in)
repOptions - A reference to a com.esri.arcgis.geodatabase.IGPReplicaOptions (in)
layerFolder - The layerFolder (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

synchronizeReplica

public void synchronizeReplica(IGraphicFeatureServer trgGFS,
                               IWorkspace srcWorkspace,
                               String replicaName,
                               int dir)
                        throws IOException,
                               AutomationException
Synchronize a feature package replica with graphic feature server replica.

Product Availability

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

Specified by:
synchronizeReplica in interface IGFSReplicationAgent
Parameters:
trgGFS - A reference to a com.esri.arcgis.carto.IGraphicFeatureServer (in)
srcWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
replicaName - The replicaName (in)
dir - A com.esri.arcgis.geodatabasedistributed.esriReplicaSynchronizeDirection constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCancelTrackerByRef

public void setCancelTrackerByRef(ITrackCancel rhs1)
                           throws IOException,
                                  AutomationException
The cancel tracker to inspect for user cancellations.

Remarks

The putref_CancelTracker method inspects for user cancellations.

Product Availability

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

Specified by:
setCancelTrackerByRef in interface IReplicationAgentCancelControl
Parameters:
rhs1 - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException
enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException
findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.