com.esri.arcgis.trackinganalyst
Class ServerConnection

java.lang.Object
  com.esri.arcgis.trackinganalyst.ServerConnection

All Implemented Interfaces:

IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IConnectionStatistics, IMarshal, IServerConnection, IServerConnection2, ITxConnectionMessages, java.io.Externalizable, java.io.Serializable

public class ServerConnection
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerConnection, IServerConnection2, ITxConnectionMessages, IMarshal, ISupportErrorInfo, IPersistStream, IConnectionPointContainer, IDocumentVersionSupportGEN, IConnectionStatistics, java.io.Externalizable

COM Class 'ServerConnection'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Manages connection to Tracking Server.' 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.trackinganalyst.IServerConnection

IID, IIDcc018a11_24fb_11d4_b34c_00104ba2abcc, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.IServerConnection2

IID, IIDf6e2800d_d512_46c1_b92c_d66c1c432a0b, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITxConnectionMessages

IID, IID07e7567e_20bd_4a55_a9ae_a9acf1dfa2fc, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.IMarshal

IID, IID00000003_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, 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.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.IConnectionStatistics

IID, IID9de7ca3b_37d0_48b4_9a64_95d2372903d0, xxDummy

Constructor Summary

ServerConnection()
Constructs a ServerConnection using ArcGIS Engine.

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

Method Summary

void	add_IPlugInEventsListener(_IPlugInEvents theListener) add_IPlugInEventsListener.
void	connect(java.lang.String bstrUserName, java.lang.String bstrPassword) Creates connection to the server.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	disableDataDefinition(java.lang.String bstrDataDefinitionID) Disables data definition for the server connection.
void	disconnect() Disconnects connection from the server.
void	disconnectObject(int dwReserved) disconnectObject
void	enableDataDefinition(java.lang.String bstrDataDefinitionID) Enables data definition for the server connection.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getConnectionName() Indicates the name of the connection to the server.
IPropSet	getConnectionProperties() Properties for the server connection.
java.lang.String	getConnectionString() Connection string value for the server connection.
java.lang.Object	getCurrentDiscardedMessageCount() Indicates current number of messages discarded.
IDatasetDef	getDataSetDefinition(java.lang.String bstrName) Gets dataset definition information for the server connection.
java.lang.Object	getDataSetDefinitionList() Lists the dataset definition information for the connection.
java.lang.Object	getDiscardedMessageCount() Indicates total number of messages discarded.
java.lang.Object	getEnabledDataDefinitions() Indicates which data definitions are enabled.
int	getEventReadyHandle() The handle to the event that is signaled when a message is ready to be received.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLastConnectionErrorCode() Indicates the error code for the last connection to the server.
java.lang.String	getLastConnectionErrorMessage() Indicates the error message for the last connection to the server.
void	getMarshalSizeMax(GUID riid, int pv, int dwDestContext, int pvDestContext, int mshlflags, int[] pSize) getMarshalSizeMax
IMessage	getMessage(int nTimeOutInMilliseconds) Retrieves a message from the server connection.
int	getMessageCount() The count of messages ready to retrieve.
IPlugin	getPlugIn() Data link plugin information for the server connection.
java.lang.Object	getPulledMessageCount() Indicates total number of messages pulled.
java.lang.Object	getQueuedMessageCount() Indicates total number of messages queued.
java.lang.Object	getReceivedMessageCount() Indicates total number of messages received.
java.lang.Object	getServerActions(boolean bForEditing) Actions used on data in the server connection.
java.lang.String	getServerName() Name for the server.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITrackingServiceDef	getTrackingService(java.lang.String bstrName) Gets tracking service for the server connection.
java.lang.Object	getTrackingServicesList() List of tracking services.
void	getUnmarshalClass(GUID riid, int pv, int dwDestContext, int pvDestContext, int mshlflags, GUID[] pCid) getUnmarshalClass
java.lang.String	getUserName() User's login name.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isConnected() Indicates whether the server connection is connected.
void	isDirty() isDirty
boolean	isEnableDataFiltering() Indicates whether data filtering is enabled for the connection.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	marshalInterface(IStream pStm, GUID riid, int pv, int dwDestContext, int pvDestContext, int mshlflags) marshalInterface
IMessage	nextMessage() Retrieves a message from the server connection.
void	readExternal(java.io.ObjectInput in)
void	release() Release a ServerConnection.
void	releaseMarshalData(IStream pStm) releaseMarshalData
void	remove_IPlugInEventsListener(_IPlugInEvents theListener) remove_IPlugInEventsListener.
void	returnDataSetDefinition(IDatasetDef piDataSetDef) Returns dataset definition information for the server connection.
void	returnServerActions(boolean bSave, java.lang.Object piActionCollection) Actions used on data in the server connection.
void	returnTrackingService(ITrackingServiceDef piTrackingServiceDef) Returns tracking service for the server connection.
void	save(IStream pstm, int fClearDirty) save
IResponseMessage	sendCommand(ICommandMessage piCmdMsg, int nTimeOut) Sends a command to the server connection.
void	sendMessage(IMessage piMessage) Sends a message through the server connection path.
void	setConnectionName(java.lang.String pbstrConnectionName) Indicates the name of the connection to the server.
void	setConnectionProperties(IPropSet ppiProperties) Properties for the server connection.
void	setConnectionString(java.lang.String pbstrConnectionString) Connection string value for the server connection.
void	setEnableDataFiltering(boolean pbvVal) Indicates whether data filtering is enabled for the connection.
void	setServerName(java.lang.String pVal) Name for the server.
void	unmarshalInterface(IStream pStm, GUID riid, int ppv) unmarshalInterface
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

ServerConnection

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

Constructs a ServerConnection using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ServerConnection

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

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

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

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

add_IPlugInEventsListener

public void add_IPlugInEventsListener(_IPlugInEvents theListener)
                               throws java.io.IOException

add_IPlugInEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._IPlugInEvents interface.

Throws:

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

remove_IPlugInEventsListener

public void remove_IPlugInEventsListener(_IPlugInEvents theListener)
                                  throws java.io.IOException

remove_IPlugInEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._IPlugInEvents interface.

Throws:

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

release

public void release()

Release a ServerConnection.

Specified by:

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

isConnected

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

Indicates whether the server connection is connected.

Specified by:

isConnected in interface IServerConnection

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerName

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

Name for the server.

Specified by:

getServerName in interface IServerConnection

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setServerName

public void setServerName(java.lang.String pVal)
                   throws java.io.IOException,
                          AutomationException

Name for the server.

Specified by:

setServerName in interface IServerConnection

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUserName

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

User's login name.

Specified by:

getUserName in interface IServerConnection

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnableDataFiltering

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

Indicates whether data filtering is enabled for the connection.

Specified by:

isEnableDataFiltering in interface IServerConnection

Returns:

The pbvVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnableDataFiltering

public void setEnableDataFiltering(boolean pbvVal)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether data filtering is enabled for the connection.

Specified by:

setEnableDataFiltering in interface IServerConnection

Parameters:

pbvVal - The pbvVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinitionList

public java.lang.Object getDataSetDefinitionList()
                                          throws java.io.IOException,
                                                 AutomationException

Lists the dataset definition information for the connection.

Specified by:

getDataSetDefinitionList in interface IServerConnection

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEnabledDataDefinitions

public java.lang.Object getEnabledDataDefinitions()
                                           throws java.io.IOException,
                                                  AutomationException

Indicates which data definitions are enabled.

Specified by:

getEnabledDataDefinitions in interface IServerConnection

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorCode

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

Indicates the error code for the last connection to the server.

Specified by:

getLastConnectionErrorCode in interface IServerConnection

Returns:

The pnErrorCode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorMessage

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

Indicates the error message for the last connection to the server.

Specified by:

getLastConnectionErrorMessage in interface IServerConnection

Returns:

The pbstrErrorMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionName

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

Indicates the name of the connection to the server.

Specified by:

getConnectionName in interface IServerConnection

Returns:

The pbstrConnectionName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConnectionName

public void setConnectionName(java.lang.String pbstrConnectionName)
                       throws java.io.IOException,
                              AutomationException

Indicates the name of the connection to the server.

Specified by:

setConnectionName in interface IServerConnection

Parameters:

pbstrConnectionName - The pbstrConnectionName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionString

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

Connection string value for the server connection.

Specified by:

getConnectionString in interface IServerConnection

Returns:

The pbstrConnectionString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConnectionString

public void setConnectionString(java.lang.String pbstrConnectionString)
                         throws java.io.IOException,
                                AutomationException

Connection string value for the server connection.

Specified by:

setConnectionString in interface IServerConnection

Parameters:

pbstrConnectionString - The pbstrConnectionString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

connect

public void connect(java.lang.String bstrUserName,
                    java.lang.String bstrPassword)
             throws java.io.IOException,
                    AutomationException

Creates connection to the server.

Specified by:

connect in interface IServerConnection

Parameters:

bstrUserName - The bstrUserName (in)

bstrPassword - The bstrPassword (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disconnect

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

Disconnects connection from the server.

Specified by:

disconnect in interface IServerConnection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sendMessage

public void sendMessage(IMessage piMessage)
                 throws java.io.IOException,
                        AutomationException

Sends a message through the server connection path.

Specified by:

sendMessage in interface IServerConnection

Parameters:

piMessage - A reference to a com.esri.arcgis.trackinganalyst.IMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessage

public IMessage getMessage(int nTimeOutInMilliseconds)
                    throws java.io.IOException,
                           AutomationException

Retrieves a message from the server connection.

Specified by:

getMessage in interface IServerConnection

Parameters:

nTimeOutInMilliseconds - The nTimeOutInMilliseconds (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enableDataDefinition

public void enableDataDefinition(java.lang.String bstrDataDefinitionID)
                          throws java.io.IOException,
                                 AutomationException

Enables data definition for the server connection.

Specified by:

enableDataDefinition in interface IServerConnection

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disableDataDefinition

public void disableDataDefinition(java.lang.String bstrDataDefinitionID)
                           throws java.io.IOException,
                                  AutomationException

Disables data definition for the server connection.

Specified by:

disableDataDefinition in interface IServerConnection

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

returnDataSetDefinition

public void returnDataSetDefinition(IDatasetDef piDataSetDef)
                             throws java.io.IOException,
                                    AutomationException

Returns dataset definition information for the server connection.

Specified by:

returnDataSetDefinition in interface IServerConnection

Parameters:

piDataSetDef - A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinition

public IDatasetDef getDataSetDefinition(java.lang.String bstrName)
                                 throws java.io.IOException,
                                        AutomationException

Gets dataset definition information for the server connection.

Specified by:

getDataSetDefinition in interface IServerConnection

Parameters:

bstrName - The bstrName (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sendCommand

public IResponseMessage sendCommand(ICommandMessage piCmdMsg,
                                    int nTimeOut)
                             throws java.io.IOException,
                                    AutomationException

Sends a command to the server connection.

Specified by:

sendCommand in interface IServerConnection

Parameters:

piCmdMsg - A reference to a com.esri.arcgis.trackinganalyst.ICommandMessage (in)

nTimeOut - The nTimeOut (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IResponseMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

public IPropSet getConnectionProperties()
                                 throws java.io.IOException,
                                        AutomationException

Properties for the server connection.

Specified by:

getConnectionProperties in interface IServerConnection2

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IPropSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConnectionProperties

public void setConnectionProperties(IPropSet ppiProperties)
                             throws java.io.IOException,
                                    AutomationException

Properties for the server connection.

Specified by:

setConnectionProperties in interface IServerConnection2

Parameters:

ppiProperties - A reference to a com.esri.arcgis.trackinganalyst.IPropSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPlugIn

public IPlugin getPlugIn()
                  throws java.io.IOException,
                         AutomationException

Data link plugin information for the server connection.

Specified by:

getPlugIn in interface IServerConnection2

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IPlugin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackingServicesList

public java.lang.Object getTrackingServicesList()
                                         throws java.io.IOException,
                                                AutomationException

List of tracking services.

Specified by:

getTrackingServicesList in interface IServerConnection2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackingService

public ITrackingServiceDef getTrackingService(java.lang.String bstrName)
                                       throws java.io.IOException,
                                              AutomationException

Gets tracking service for the server connection.

Specified by:

getTrackingService in interface IServerConnection2

Parameters:

bstrName - The bstrName (in)

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ITrackingServiceDef

Throws:

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

AutomationException - If the ArcObject component throws an exception.

returnTrackingService

public void returnTrackingService(ITrackingServiceDef piTrackingServiceDef)
                           throws java.io.IOException,
                                  AutomationException

Returns tracking service for the server connection.

Specified by:

returnTrackingService in interface IServerConnection2

Parameters:

piTrackingServiceDef - A reference to a com.esri.arcgis.geodatabaseextensions.ITrackingServiceDef (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerActions

public java.lang.Object getServerActions(boolean bForEditing)
                                  throws java.io.IOException,
                                         AutomationException

Actions used on data in the server connection.

Specified by:

getServerActions in interface IServerConnection2

Parameters:

bForEditing - The bForEditing (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

returnServerActions

public void returnServerActions(boolean bSave,
                                java.lang.Object piActionCollection)
                         throws java.io.IOException,
                                AutomationException

Actions used on data in the server connection.

Specified by:

returnServerActions in interface IServerConnection2

Parameters:

bSave - The bSave (in)

piActionCollection - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessageCount

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

The count of messages ready to retrieve.

Specified by:

getMessageCount in interface ITxConnectionMessages

Returns:

The plNumberOfMessages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEventReadyHandle

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

The handle to the event that is signaled when a message is ready to be received.

Specified by:

getEventReadyHandle in interface ITxConnectionMessages

Returns:

The phReadyEvent (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

nextMessage

public IMessage nextMessage()
                     throws java.io.IOException,
                            AutomationException

Retrieves a message from the server connection.

Specified by:

nextMessage in interface ITxConnectionMessages

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnmarshalClass

public void getUnmarshalClass(GUID riid,
                              int pv,
                              int dwDestContext,
                              int pvDestContext,
                              int mshlflags,
                              GUID[] pCid)
                       throws java.io.IOException,
                              AutomationException

getUnmarshalClass

Specified by:

getUnmarshalClass in interface IMarshal

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

pv - A COM void* (in)

dwDestContext - The dwDestContext (in)

pvDestContext - A COM void* (in)

mshlflags - The mshlflags (in)

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

getMarshalSizeMax

public void getMarshalSizeMax(GUID riid,
                              int pv,
                              int dwDestContext,
                              int pvDestContext,
                              int mshlflags,
                              int[] pSize)
                       throws java.io.IOException,
                              AutomationException

getMarshalSizeMax

Specified by:

getMarshalSizeMax in interface IMarshal

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

pv - A COM void* (in)

dwDestContext - The dwDestContext (in)

pvDestContext - A COM void* (in)

mshlflags - The mshlflags (in)

pSize - The pSize (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

marshalInterface

public void marshalInterface(IStream pStm,
                             GUID riid,
                             int pv,
                             int dwDestContext,
                             int pvDestContext,
                             int mshlflags)
                      throws java.io.IOException,
                             AutomationException

marshalInterface

Specified by:

marshalInterface in interface IMarshal

Parameters:

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

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

pv - A COM void* (in)

dwDestContext - The dwDestContext (in)

pvDestContext - A COM void* (in)

mshlflags - The mshlflags (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unmarshalInterface

public void unmarshalInterface(IStream pStm,
                               GUID riid,
                               int ppv)
                        throws java.io.IOException,
                               AutomationException

unmarshalInterface

Specified by:

unmarshalInterface in interface IMarshal

Parameters:

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

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppv - A COM void* (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

releaseMarshalData

public void releaseMarshalData(IStream pStm)
                        throws java.io.IOException,
                               AutomationException

releaseMarshalData

Specified by:

releaseMarshalData in interface IMarshal

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.

disconnectObject

public void disconnectObject(int dwReserved)
                      throws java.io.IOException,
                             AutomationException

disconnectObject

Specified by:

disconnectObject in interface IMarshal

Parameters:

dwReserved - The dwReserved (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

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.

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.

enumConnectionPoints

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

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

findConnectionPoint

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:

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

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReceivedMessageCount

public java.lang.Object getReceivedMessageCount()
                                         throws java.io.IOException,
                                                AutomationException

Indicates total number of messages received.

Specified by:

getReceivedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPulledMessageCount

public java.lang.Object getPulledMessageCount()
                                       throws java.io.IOException,
                                              AutomationException

Indicates total number of messages pulled.

Specified by:

getPulledMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDiscardedMessageCount

public java.lang.Object getDiscardedMessageCount()
                                          throws java.io.IOException,
                                                 AutomationException

Indicates total number of messages discarded.

Specified by:

getDiscardedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentDiscardedMessageCount

public java.lang.Object getCurrentDiscardedMessageCount()
                                                 throws java.io.IOException,
                                                        AutomationException

Indicates current number of messages discarded.

Specified by:

getCurrentDiscardedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getQueuedMessageCount

public java.lang.Object getQueuedMessageCount()
                                       throws java.io.IOException,
                                              AutomationException

Indicates total number of messages queued.

Specified by:

getQueuedMessageCount in interface IConnectionStatistics

Returns:

A Variant

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