com.esri.arcgis.geodatabase
Class GPReplicaOptions

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

All Implemented Interfaces:

IGPReplicaOptions, IGPReplicaOptions2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class GPReplicaOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPReplicaOptions, IGPReplicaOptions2, IXMLSerialize, IPersist, IPersistStream, IXMLVersionSupport, Externalizable

Defines replica options.

Remarks

When creating a replica, the GPReplicaOptions define replica options such as the type of replica and the connection strings to the geodatabases involved. This is used with the CreateReplica methods on the GeoDataServer and ReplicationAgent classes.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GPReplicaOptions()
Constructs a GPReplicaOptions using ArcGIS Engine.

GPReplicaOptions(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPReplicaOptions theGPReplicaOptions = (GPReplicaOptions) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
int	getAccessType() The replica access type.
String	getChildConnectionString() The connection string for the child geodatabase.
int	getChildReconcilePolicy() The childs replica reconcile property.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
String	getParentConnectionString() The connection string for the parent geodatabase.
int	getParentReconcilePolicy() The parents replica reconcile policy.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
boolean	isChildFirstSender() Indicates if the child replica will be the first sender.
void	isDirty() isDirty
boolean	isIncludeMapLayers() isIncludeMapLayers
boolean	isRegisterReplicaOnly() Indicates if the replica will be created using the register existing data only option.
boolean	isResolveDatasetNameConflicts() Resolve dataset name conflicts when creating replicas.
boolean	isReturnAllExpandedDatasets() Return all datasets including feature datasets, topologies, and geometric networks when expanding.
boolean	isUseArchiving() Use archiving instead of versions to track changes in one way replicas.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAccessType(int accessType) The replica access type.
void	setChildConnectionString(String childConnectionString) The connection string for the child geodatabase.
void	setChildReconcilePolicy(int childPolicy) The childs replica reconcile property.
void	setIncludeMapLayers(boolean includeMapLayers) setIncludeMapLayers
void	setIsChildFirstSender(boolean childIsFirstSender) Indicates if the child replica will be the first sender.
void	setParentConnectionString(String parentConnectionString) The connection string for the parent geodatabase.
void	setParentReconcilePolicy(int parentPolicy) The parents replica reconcile policy.
void	setRegisterReplicaOnly(boolean registerReplicaData) Indicates if the replica will be created using the register existing data only option.
void	setResolveDatasetNameConflicts(boolean resolveNameConflicts) Resolve dataset name conflicts when creating replicas.
void	setReturnAllExpandedDatasets(boolean returnAllExpandedDatasets) Return all datasets including feature datasets, topologies, and geometric networks when expanding.
void	setUseArchiving(boolean useArchiving) Use archiving instead of versions to track changes in one way replicas.
void	writeExternal(ObjectOutput out)

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

GPReplicaOptions

public GPReplicaOptions()
                 throws IOException,
                        UnknownHostException

Constructs a GPReplicaOptions using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPReplicaOptions

public GPReplicaOptions(Object obj)
                 throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPReplicaOptions theGPReplicaOptions = (GPReplicaOptions) obj;

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

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

setIsChildFirstSender

public void setIsChildFirstSender(boolean childIsFirstSender)
                           throws IOException,
                                  AutomationException

Indicates if the child replica will be the first sender.

Product Availability

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

Specified by:

setIsChildFirstSender in interface IGPReplicaOptions

Parameters:

childIsFirstSender - The childIsFirstSender (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isChildFirstSender

public boolean isChildFirstSender()
                           throws IOException,
                                  AutomationException

Indicates if the child replica will be the first sender.

Product Availability

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

Specified by:

isChildFirstSender in interface IGPReplicaOptions

Returns:

The childIsFirstSender

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAccessType

public void setAccessType(int accessType)
                   throws IOException,
                          AutomationException

The replica access type.

Product Availability

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

Specified by:

setAccessType in interface IGPReplicaOptions

Parameters:

accessType - A com.esri.arcgis.geodatabase.esriReplicaAccessType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAccessType

public int getAccessType()
                  throws IOException,
                         AutomationException

The replica access type.

Product Availability

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

Specified by:

getAccessType in interface IGPReplicaOptions

Returns:

A com.esri.arcgis.geodatabase.esriReplicaAccessType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChildReconcilePolicy

public void setChildReconcilePolicy(int childPolicy)
                             throws IOException,
                                    AutomationException

The childs replica reconcile property.

Product Availability

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

Specified by:

setChildReconcilePolicy in interface IGPReplicaOptions

Parameters:

childPolicy - A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildReconcilePolicy

public int getChildReconcilePolicy()
                            throws IOException,
                                   AutomationException

The childs replica reconcile property.

Remarks

For the current release of ArcGIS, the only valid value for this property is esriReplicaResolveConflictsNone. When creating a replica, an error occurs if you try to use differnet enumeration value.

Product Availability

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

Specified by:

getChildReconcilePolicy in interface IGPReplicaOptions

Returns:

A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentReconcilePolicy

public void setParentReconcilePolicy(int parentPolicy)
                              throws IOException,
                                     AutomationException

The parents replica reconcile policy.

Product Availability

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

Specified by:

setParentReconcilePolicy in interface IGPReplicaOptions

Parameters:

parentPolicy - A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentReconcilePolicy

public int getParentReconcilePolicy()
                             throws IOException,
                                    AutomationException

The parents replica reconcile policy.

Remarks

For the current release of ArcGIS, the only valid value for this property is esriReplicaResolveConflictsNone. When creating a replica, an error occurs if you try to use differnet enumeration value.

Product Availability

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

Specified by:

getParentReconcilePolicy in interface IGPReplicaOptions

Returns:

A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRegisterReplicaOnly

public void setRegisterReplicaOnly(boolean registerReplicaData)
                            throws IOException,
                                   AutomationException

Indicates if the replica will be created using the register existing data only option.

Product Availability

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

Specified by:

setRegisterReplicaOnly in interface IGPReplicaOptions

Parameters:

registerReplicaData - The registerReplicaData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRegisterReplicaOnly

public boolean isRegisterReplicaOnly()
                              throws IOException,
                                     AutomationException

Indicates if the replica will be created using the register existing data only option.

Product Availability

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

Specified by:

isRegisterReplicaOnly in interface IGPReplicaOptions

Returns:

The registerReplicaData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChildConnectionString

public void setChildConnectionString(String childConnectionString)
                              throws IOException,
                                     AutomationException

The connection string for the child geodatabase.

Product Availability

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

Specified by:

setChildConnectionString in interface IGPReplicaOptions

Parameters:

childConnectionString - The childConnectionString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildConnectionString

public String getChildConnectionString()
                                throws IOException,
                                       AutomationException

The connection string for the child geodatabase.

Remarks

Set this property to the connection string for the ArcSDE geodatabase or the geodata service referencing the ArcSDE geodatabase that will host the child replica. Setting the property stores the connection string with the parent replica. This allows you to synchronzie without having to ask for the child replicas geodatabase when synchronizing from the parent.

Product Availability

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

Specified by:

getChildConnectionString in interface IGPReplicaOptions

Returns:

The childConnectionString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentConnectionString

public void setParentConnectionString(String parentConnectionString)
                               throws IOException,
                                      AutomationException

The connection string for the parent geodatabase.

Product Availability

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

Specified by:

setParentConnectionString in interface IGPReplicaOptions

Parameters:

parentConnectionString - The parentConnectionString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentConnectionString

public String getParentConnectionString()
                                 throws IOException,
                                        AutomationException

The connection string for the parent geodatabase.

Remarks

Set this property to the connection string for the ArcSDE geodatabase or the geodata service referencing the ArcSDE geodatabase that will host the parent replica. Setting the property stores the connection string with the child replica. This allows you to synchronzie without having to ask for the parent replicas geodatabase when synchronizing from the child.

Product Availability

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

Specified by:

getParentConnectionString in interface IGPReplicaOptions

Returns:

The parentConnectionString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseArchiving

public void setUseArchiving(boolean useArchiving)
                     throws IOException,
                            AutomationException

Use archiving instead of versions to track changes in one way replicas.

Product Availability

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

Specified by:

setUseArchiving in interface IGPReplicaOptions2

Parameters:

useArchiving - The useArchiving (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseArchiving

public boolean isUseArchiving()
                       throws IOException,
                              AutomationException

Use archiving instead of versions to track changes in one way replicas.

Product Availability

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

Specified by:

isUseArchiving in interface IGPReplicaOptions2

Returns:

The useArchiving

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIncludeMapLayers

public void setIncludeMapLayers(boolean includeMapLayers)
                         throws IOException,
                                AutomationException

setIncludeMapLayers

Product Availability

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

Specified by:

setIncludeMapLayers in interface IGPReplicaOptions2

Parameters:

includeMapLayers - The includeMapLayers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIncludeMapLayers

public boolean isIncludeMapLayers()
                           throws IOException,
                                  AutomationException

isIncludeMapLayers

Product Availability

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

Specified by:

isIncludeMapLayers in interface IGPReplicaOptions2

Returns:

The includeMapLayers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnAllExpandedDatasets

public void setReturnAllExpandedDatasets(boolean returnAllExpandedDatasets)
                                  throws IOException,
                                         AutomationException

Return all datasets including feature datasets, topologies, and geometric networks when expanding.

Product Availability

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

Specified by:

setReturnAllExpandedDatasets in interface IGPReplicaOptions2

Parameters:

returnAllExpandedDatasets - The returnAllExpandedDatasets (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnAllExpandedDatasets

public boolean isReturnAllExpandedDatasets()
                                    throws IOException,
                                           AutomationException

Return all datasets including feature datasets, topologies, and geometric networks when expanding.

Product Availability

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

Specified by:

isReturnAllExpandedDatasets in interface IGPReplicaOptions2

Returns:

The returnAllExpandedDatasets

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResolveDatasetNameConflicts

public void setResolveDatasetNameConflicts(boolean resolveNameConflicts)
                                    throws IOException,
                                           AutomationException

Resolve dataset name conflicts when creating replicas.

Product Availability

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

Specified by:

setResolveDatasetNameConflicts in interface IGPReplicaOptions2

Parameters:

resolveNameConflicts - The resolveNameConflicts (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isResolveDatasetNameConflicts

public boolean isResolveDatasetNameConflicts()
                                      throws IOException,
                                             AutomationException

Resolve dataset name conflicts when creating replicas.

Product Availability

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

Specified by:

isResolveDatasetNameConflicts in interface IGPReplicaOptions2

Returns:

The resolveNameConflicts

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist 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:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream 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:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream 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:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream 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:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream 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:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException