com.esri.arcgis.geodatabase
Class GPReplicaOptions

java.lang.Object
  extended by com.esri.arcgis.geodatabase.GPReplicaOptions
All Implemented Interfaces:
IGPReplicaOptions, IGPReplicaOptions2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

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

COM Class 'GPReplicaOptions'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'Defines replica options.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.geodatabase.IGPReplicaOptions2
IID, IIDc2d25f91_087a_4b2e_bfe1_2dbac9cd6128, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IGPReplicaOptions
IIDc75f38cc_f589_42cd_9a85_b0be9b7fcd2b
 
Fields inherited from interface com.esri.arcgis.system.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport
IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy
 
Constructor Summary
GPReplicaOptions()
          Constructs a GPReplicaOptions using ArcGIS Engine.
GPReplicaOptions(java.lang.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(java.lang.Object o)
          Compare this object with another
 int getAccessType()
          The replica access type.
 java.lang.String getChildConnectionString()
          The connection string for the child geodatabase.
 int getChildReconcilePolicy()
          The childs replica reconcile property.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 java.lang.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(java.io.ObjectInput in)
           
 void release()
          Release a GPReplicaOptions.
 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(java.lang.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(java.lang.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(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

GPReplicaOptions

public GPReplicaOptions()
                 throws java.io.IOException,
                        java.net.UnknownHostException
Constructs a GPReplicaOptions using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GPReplicaOptions

public GPReplicaOptions(java.lang.Object obj)
                 throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a GPReplicaOptions.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setIsChildFirstSender

public void setIsChildFirstSender(boolean childIsFirstSender)
                           throws java.io.IOException,
                                  AutomationException
Indicates if the child replica will be the first sender.

Specified by:
setIsChildFirstSender in interface IGPReplicaOptions
Parameters:
childIsFirstSender - The childIsFirstSender (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isChildFirstSender

public boolean isChildFirstSender()
                           throws java.io.IOException,
                                  AutomationException
Indicates if the child replica will be the first sender.

Specified by:
isChildFirstSender in interface IGPReplicaOptions
Returns:
The childIsFirstSender
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAccessType

public void setAccessType(int accessType)
                   throws java.io.IOException,
                          AutomationException
The replica access type.

Specified by:
setAccessType in interface IGPReplicaOptions
Parameters:
accessType - A com.esri.arcgis.geodatabase.esriReplicaAccessType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAccessType

public int getAccessType()
                  throws java.io.IOException,
                         AutomationException
The replica access type.

Specified by:
getAccessType in interface IGPReplicaOptions
Returns:
A com.esri.arcgis.geodatabase.esriReplicaAccessType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setChildReconcilePolicy

public void setChildReconcilePolicy(int childPolicy)
                             throws java.io.IOException,
                                    AutomationException
The childs replica reconcile property.

Specified by:
setChildReconcilePolicy in interface IGPReplicaOptions
Parameters:
childPolicy - A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChildReconcilePolicy

public int getChildReconcilePolicy()
                            throws java.io.IOException,
                                   AutomationException
The childs replica reconcile property.

Specified by:
getChildReconcilePolicy in interface IGPReplicaOptions
Returns:
A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParentReconcilePolicy

public void setParentReconcilePolicy(int parentPolicy)
                              throws java.io.IOException,
                                     AutomationException
The parents replica reconcile policy.

Specified by:
setParentReconcilePolicy in interface IGPReplicaOptions
Parameters:
parentPolicy - A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParentReconcilePolicy

public int getParentReconcilePolicy()
                             throws java.io.IOException,
                                    AutomationException
The parents replica reconcile policy.

Specified by:
getParentReconcilePolicy in interface IGPReplicaOptions
Returns:
A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRegisterReplicaOnly

public void setRegisterReplicaOnly(boolean registerReplicaData)
                            throws java.io.IOException,
                                   AutomationException
Indicates if the replica will be created using the register existing data only option.

Specified by:
setRegisterReplicaOnly in interface IGPReplicaOptions
Parameters:
registerReplicaData - The registerReplicaData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRegisterReplicaOnly

public boolean isRegisterReplicaOnly()
                              throws java.io.IOException,
                                     AutomationException
Indicates if the replica will be created using the register existing data only option.

Specified by:
isRegisterReplicaOnly in interface IGPReplicaOptions
Returns:
The registerReplicaData
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setChildConnectionString

public void setChildConnectionString(java.lang.String childConnectionString)
                              throws java.io.IOException,
                                     AutomationException
The connection string for the child geodatabase.

Specified by:
setChildConnectionString in interface IGPReplicaOptions
Parameters:
childConnectionString - The childConnectionString (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChildConnectionString

public java.lang.String getChildConnectionString()
                                          throws java.io.IOException,
                                                 AutomationException
The connection string for the child geodatabase.

Specified by:
getChildConnectionString in interface IGPReplicaOptions
Returns:
The childConnectionString
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParentConnectionString

public void setParentConnectionString(java.lang.String parentConnectionString)
                               throws java.io.IOException,
                                      AutomationException
The connection string for the parent geodatabase.

Specified by:
setParentConnectionString in interface IGPReplicaOptions
Parameters:
parentConnectionString - The parentConnectionString (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParentConnectionString

public java.lang.String getParentConnectionString()
                                           throws java.io.IOException,
                                                  AutomationException
The connection string for the parent geodatabase.

Specified by:
getParentConnectionString in interface IGPReplicaOptions
Returns:
The parentConnectionString
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseArchiving

public void setUseArchiving(boolean useArchiving)
                     throws java.io.IOException,
                            AutomationException
Use archiving instead of versions to track changes in one way replicas.

Specified by:
setUseArchiving in interface IGPReplicaOptions2
Parameters:
useArchiving - The useArchiving (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseArchiving

public boolean isUseArchiving()
                       throws java.io.IOException,
                              AutomationException
Use archiving instead of versions to track changes in one way replicas.

Specified by:
isUseArchiving in interface IGPReplicaOptions2
Returns:
The useArchiving
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIncludeMapLayers

public void setIncludeMapLayers(boolean includeMapLayers)
                         throws java.io.IOException,
                                AutomationException
setIncludeMapLayers

Specified by:
setIncludeMapLayers in interface IGPReplicaOptions2
Parameters:
includeMapLayers - The includeMapLayers (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIncludeMapLayers

public boolean isIncludeMapLayers()
                           throws java.io.IOException,
                                  AutomationException
isIncludeMapLayers

Specified by:
isIncludeMapLayers in interface IGPReplicaOptions2
Returns:
The includeMapLayers
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnAllExpandedDatasets

public void setReturnAllExpandedDatasets(boolean returnAllExpandedDatasets)
                                  throws java.io.IOException,
                                         AutomationException
Return all datasets including feature datasets, topologies, and geometric networks when expanding.

Specified by:
setReturnAllExpandedDatasets in interface IGPReplicaOptions2
Parameters:
returnAllExpandedDatasets - The returnAllExpandedDatasets (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnAllExpandedDatasets

public boolean isReturnAllExpandedDatasets()
                                    throws java.io.IOException,
                                           AutomationException
Return all datasets including feature datasets, topologies, and geometric networks when expanding.

Specified by:
isReturnAllExpandedDatasets in interface IGPReplicaOptions2
Returns:
The returnAllExpandedDatasets
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResolveDatasetNameConflicts

public void setResolveDatasetNameConflicts(boolean resolveNameConflicts)
                                    throws java.io.IOException,
                                           AutomationException
Resolve dataset name conflicts when creating replicas.

Specified by:
setResolveDatasetNameConflicts in interface IGPReplicaOptions2
Parameters:
resolveNameConflicts - The resolveNameConflicts (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isResolveDatasetNameConflicts

public boolean isResolveDatasetNameConflicts()
                                      throws java.io.IOException,
                                             AutomationException
Resolve dataset name conflicts when creating replicas.

Specified by:
isResolveDatasetNameConflicts in interface IGPReplicaOptions2
Returns:
The resolveNameConflicts
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException