com.esri.arcgis.geodatabase
Class GPReplicaDescription

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

All Implemented Interfaces:

IGPReplicaDescription, IGPValue, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class GPReplicaDescription
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPReplicaDescription, IGPValue, IXMLSerialize, IPersist, IPersistStream, IXMLVersionSupport, java.io.Externalizable

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

Description 'Defines the data to replicate or extract.' 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.IGPReplicaDescription

IID, IIDe4c1358f_56cf_4c9b_99cd_1bf58d45f1bb, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue

IID, IID92ee08b6_c757_4178_803c_67cd665ac801, xxDummy

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

GPReplicaDescription()
Constructs a GPReplicaDescription using ArcGIS Engine.

GPReplicaDescription(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPReplicaDescription theGPReplicaDescription = (GPReplicaDescription) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	empty() Clears the value object.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getAsText() Provides the value of the value object.
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).
int	getModelType() The replica model type.
IGeometry	getQueryGeometry() The shape that determines which features are replicated.
IGPReplicaDatasets	getReplicaDatasets() The datasets in the replica.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getSpatialRelation() Defines how the shape returned by the QueryGeometry property is applied during replication and synchronization.
int	hashCode() the hashcode for this object
IGPDataType	IGPValue_getDataType() The data type of the value object.
void	init(IReplica replica) Initializes the object from an existing replica.
void	isDirty() isDirty
boolean	isEmpty() Indicates if the value object is empty.
boolean	isSingleGeneration() Indicates if the replica is a check-out.
boolean	isTransferRelatedObjects() Indicates if related objects are replicated.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a GPReplicaDescription.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
IGPMessage	setAsText(java.lang.String text) Provides the value of the value object with the given string value.
void	setModelType(int modelType) The replica model type.
void	setQueryGeometryByRef(IGeometry queryGeometry) The shape that determines which features are replicated.
void	setReplicaDatasetsByRef(IGPReplicaDatasets replicaDatasets) The datasets in the replica.
void	setSingleGeneration(boolean singleGeneration) Indicates if the replica is a check-out.
void	setSpatialRelation(int spatialRelation) Defines how the shape returned by the QueryGeometry property is applied during replication and synchronization.
void	setTransferRelatedObjects(boolean transferRelObjects) Indicates if related objects are replicated.
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

GPReplicaDescription

public GPReplicaDescription()
                     throws java.io.IOException,
                            java.net.UnknownHostException

Constructs a GPReplicaDescription using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPReplicaDescription

public GPReplicaDescription(java.lang.Object obj)
                     throws java.io.IOException

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

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

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 GPReplicaDescription.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

init

public void init(IReplica replica)
          throws java.io.IOException,
                 AutomationException

Initializes the object from an existing replica.

Specified by:

init in interface IGPReplicaDescription

Parameters:

replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setModelType

public void setModelType(int modelType)
                  throws java.io.IOException,
                         AutomationException

The replica model type.

Specified by:

setModelType in interface IGPReplicaDescription

Parameters:

modelType - A com.esri.arcgis.geodatabase.esriReplicaModelType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModelType

public int getModelType()
                 throws java.io.IOException,
                        AutomationException

The replica model type.

Specified by:

getModelType in interface IGPReplicaDescription

Returns:

A com.esri.arcgis.geodatabase.esriReplicaModelType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSingleGeneration

public void setSingleGeneration(boolean singleGeneration)
                         throws java.io.IOException,
                                AutomationException

Indicates if the replica is a check-out.

Specified by:

setSingleGeneration in interface IGPReplicaDescription

Parameters:

singleGeneration - The singleGeneration (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSingleGeneration

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

Indicates if the replica is a check-out.

Specified by:

isSingleGeneration in interface IGPReplicaDescription

Returns:

The singleGeneration

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialRelation

public void setSpatialRelation(int spatialRelation)
                        throws java.io.IOException,
                               AutomationException

Defines how the shape returned by the QueryGeometry property is applied during replication and synchronization.

Specified by:

setSpatialRelation in interface IGPReplicaDescription

Parameters:

spatialRelation - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialRelation

public int getSpatialRelation()
                       throws java.io.IOException,
                              AutomationException

Defines how the shape returned by the QueryGeometry property is applied during replication and synchronization.

Specified by:

getSpatialRelation in interface IGPReplicaDescription

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryGeometryByRef

public void setQueryGeometryByRef(IGeometry queryGeometry)
                           throws java.io.IOException,
                                  AutomationException

The shape that determines which features are replicated.

Specified by:

setQueryGeometryByRef in interface IGPReplicaDescription

Parameters:

queryGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryGeometry

public IGeometry getQueryGeometry()
                           throws java.io.IOException,
                                  AutomationException

The shape that determines which features are replicated.

Specified by:

getQueryGeometry in interface IGPReplicaDescription

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplicaDatasetsByRef

public void setReplicaDatasetsByRef(IGPReplicaDatasets replicaDatasets)
                             throws java.io.IOException,
                                    AutomationException

The datasets in the replica.

Specified by:

setReplicaDatasetsByRef in interface IGPReplicaDescription

Parameters:

replicaDatasets - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDatasets (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicaDatasets

public IGPReplicaDatasets getReplicaDatasets()
                                      throws java.io.IOException,
                                             AutomationException

The datasets in the replica.

Specified by:

getReplicaDatasets in interface IGPReplicaDescription

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransferRelatedObjects

public void setTransferRelatedObjects(boolean transferRelObjects)
                               throws java.io.IOException,
                                      AutomationException

Indicates if related objects are replicated.

Specified by:

setTransferRelatedObjects in interface IGPReplicaDescription

Parameters:

transferRelObjects - The transferRelObjects (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTransferRelatedObjects

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

Indicates if related objects are replicated.

Specified by:

isTransferRelatedObjects in interface IGPReplicaDescription

Returns:

The transferRelObjects

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException

The data type of the value object.

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

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

Indicates if the value object is empty.

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

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

Clears the value object.

Specified by:

empty in interface IGPValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsText

public java.lang.String getAsText()
                           throws java.io.IOException,
                                  AutomationException

Provides the value of the value object.

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

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

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