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, Externalizable, Serializable

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

Manages connection to Tracking Server.

Description

The Server Connection object serves as a direct interface or connection to the Tracking Server. This connection object uses DCOM to communicate with the Tracking Server. The Tracking Server Manager and Simulator applications use this object as thier communications interface to the Tracking Server system.

Remarks

The Server Connector uses the connection properties to manage all user modifiable features of the connector. Below summarizes the properties, their defaults and descriptions.

Property Name	Required	Default Value	Description
SERVERNAME	Y	localhost	Name of Server or IP
AMS_CONNECTION_NAME	Y	Tracking Connector	The Name or label of the connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:

Serialized Form

Constructor Summary

ServerConnection()
Constructs a ServerConnection using ArcGIS Engine.

ServerConnection(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(String bstrUserName, String bstrPassword) Creates connection to the server.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	disableDataDefinition(String bstrDataDefinitionID) Disables data definition for the server connection.
void	disconnect() Disconnects connection from the server.
void	disconnectObject(int dwReserved) disconnectObject
void	enableDataDefinition(String bstrDataDefinitionID) Enables data definition for the server connection.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getConnectionName() Indicates the name of the connection to the server.
IPropSet	getConnectionProperties() Properties for the server connection.
String	getConnectionString() Connection string value for the server connection.
Object	getCurrentDiscardedMessageCount() Indicates current number of messages discarded.
IDatasetDef	getDataSetDefinition(String bstrName) Gets dataset definition information for the server connection.
Object	getDataSetDefinitionList() Lists the dataset definition information for the connection.
Object	getDiscardedMessageCount() Indicates total number of messages discarded.
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.
int	getLastConnectionErrorCode() Indicates the error code for the last connection to the server.
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.
Object	getPulledMessageCount() Indicates total number of messages pulled.
Object	getQueuedMessageCount() Indicates total number of messages queued.
Object	getReceivedMessageCount() Indicates total number of messages received.
Object	getServerActions(boolean bForEditing) Actions used on data in the server connection.
String	getServerName() Name for the server.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITrackingServiceDef	getTrackingService(String bstrName) Gets tracking service for the server connection.
Object	getTrackingServicesList() List of tracking services.
void	getUnmarshalClass(GUID riid, int pv, int dwDestContext, int pvDestContext, int mshlflags, GUID[] pCid) getUnmarshalClass
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(ObjectInput in)
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, 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(String pbstrConnectionName) Indicates the name of the connection to the server.
void	setConnectionProperties(IPropSet ppiProperties) Properties for the server connection.
void	setConnectionString(String pbstrConnectionString) Connection string value for the server connection.
void	setEnableDataFiltering(boolean pbvVal) Indicates whether data filtering is enabled for the connection.
void	setServerName(String pVal) Name for the server.
void	unmarshalInterface(IStream pStm, GUID riid, int ppv) unmarshalInterface
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

ServerConnection

public ServerConnection()
                 throws IOException,
                        UnknownHostException

Constructs a ServerConnection using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ServerConnection

public ServerConnection(Object obj)
                 throws 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:

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

add_IPlugInEventsListener

public void add_IPlugInEventsListener(_IPlugInEvents theListener)
                               throws IOException

add_IPlugInEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

IOException - If there are communications problems.

remove_IPlugInEventsListener

public void remove_IPlugInEventsListener(_IPlugInEvents theListener)
                                  throws 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:

IOException - If there are communications problems.

isConnected

public boolean isConnected()
                    throws IOException,
                           AutomationException

Indicates whether the server connection is connected.

Description

This property indicates whether the Internet server connection is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isConnected in interface IServerConnection

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerName

public String getServerName()
                     throws IOException,
                            AutomationException

Name for the server.

Description

This property indicates server name in the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getServerName in interface IServerConnection

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerName

public void setServerName(String pVal)
                   throws IOException,
                          AutomationException

Name for the server.

Description

This property sets the TMS server to connected to. The default of an empty string is localhost

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setServerName in interface IServerConnection

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserName

public String getUserName()
                   throws IOException,
                          AutomationException

User's login name.

Description

This property indicates user's name using the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getUserName in interface IServerConnection

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableDataFiltering

public boolean isEnableDataFiltering()
                              throws IOException,
                                     AutomationException

Indicates whether data filtering is enabled for the connection.

Description

This property indicates whether data filtering is enabled for the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isEnableDataFiltering in interface IServerConnection

Returns:

The pbvVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableDataFiltering

public void setEnableDataFiltering(boolean pbvVal)
                            throws IOException,
                                   AutomationException

Indicates whether data filtering is enabled for the connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setEnableDataFiltering in interface IServerConnection

Parameters:

pbvVal - The pbvVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinitionList

public Object getDataSetDefinitionList()
                                throws IOException,
                                       AutomationException

Lists the dataset definition information for the connection.

Description

This property lists values in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getDataSetDefinitionList in interface IServerConnection

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnabledDataDefinitions

public Object getEnabledDataDefinitions()
                                 throws IOException,
                                        AutomationException

Indicates which data definitions are enabled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getEnabledDataDefinitions in interface IServerConnection

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorCode

public int getLastConnectionErrorCode()
                               throws IOException,
                                      AutomationException

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

Description

This property indicates error code value for the last Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getLastConnectionErrorCode in interface IServerConnection

Returns:

The pnErrorCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorMessage

public String getLastConnectionErrorMessage()
                                     throws IOException,
                                            AutomationException

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

Description

This property indicates error message value for the last Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getLastConnectionErrorMessage in interface IServerConnection

Returns:

The pbstrErrorMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionName

public String getConnectionName()
                         throws IOException,
                                AutomationException

Indicates the name of the connection to the server.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getConnectionName in interface IServerConnection

Returns:

The pbstrConnectionName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionName

public void setConnectionName(String pbstrConnectionName)
                       throws IOException,
                              AutomationException

Indicates the name of the connection to the server.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setConnectionName in interface IServerConnection

Parameters:

pbstrConnectionName - The pbstrConnectionName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionString

public String getConnectionString()
                           throws IOException,
                                  AutomationException

Connection string value for the server connection.

Remarks

Not implemented in the current release.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getConnectionString in interface IServerConnection

Returns:

The pbstrConnectionString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionString

public void setConnectionString(String pbstrConnectionString)
                         throws IOException,
                                AutomationException

Connection string value for the server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setConnectionString in interface IServerConnection

Parameters:

pbstrConnectionString - The pbstrConnectionString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public void connect(String bstrUserName,
                    String bstrPassword)
             throws IOException,
                    AutomationException

Creates connection to the server.

Description

This method creates Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

connect in interface IServerConnection

Parameters:

bstrUserName - The bstrUserName (in)

bstrPassword - The bstrPassword (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws IOException,
                       AutomationException

Disconnects connection from the server.

Description

This method disconnects the internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

disconnect in interface IServerConnection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendMessage

public void sendMessage(IMessage piMessage)
                 throws IOException,
                        AutomationException

Sends a message through the server connection path.

Remarks

This method is not implemented in the current version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

sendMessage in interface IServerConnection

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public IMessage getMessage(int nTimeOutInMilliseconds)
                    throws IOException,
                           AutomationException

Retrieves a message from the server connection.

Description

This method gets message via the Internet server connection. The method times out after nTimeOutInMilliseconds if no message is received by the connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getMessage in interface IServerConnection

Parameters:

nTimeOutInMilliseconds - The nTimeOutInMilliseconds (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableDataDefinition

public void enableDataDefinition(String bstrDataDefinitionID)
                          throws IOException,
                                 AutomationException

Enables data definition for the server connection.

Description

This method enables a data definition for the Internet server connection specified by bstrDataDefinitionID. bstrDataDefinitionID is the key to the data definition to be enabled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

enableDataDefinition in interface IServerConnection

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disableDataDefinition

public void disableDataDefinition(String bstrDataDefinitionID)
                           throws IOException,
                                  AutomationException

Disables data definition for the server connection.

Description

This method disables a dataset definition for the internet server connection specified by bstrDataDefinitionID. bstrDataDefinitionID is the key to the dataset to be disabled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

disableDataDefinition in interface IServerConnection

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnDataSetDefinition

public void returnDataSetDefinition(IDatasetDef piDataSetDef)
                             throws IOException,
                                    AutomationException

Returns dataset definition information for the server connection.

Description

This method returns value for dataset definition in Internet server connection.

Remarks

This method does nothing in the current version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

returnDataSetDefinition in interface IServerConnection

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinition

public IDatasetDef getDataSetDefinition(String bstrName)
                                 throws IOException,
                                        AutomationException

Gets dataset definition information for the server connection.

Description

This method gets value for dataset definition for Internet server connection specified by bstrName.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getDataSetDefinition in interface IServerConnection

Parameters:

bstrName - The bstrName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendCommand

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

Sends a command to the server connection.

Remarks

This method is not implemented in the current version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

public IPropSet getConnectionProperties()
                                 throws IOException,
                                        AutomationException

Properties for the server connection.

Remarks

The internet Connector uses the connection properties to manage all user modifiable features of the connector. Below summarizes the properties, their defaults and descriptions. The Internet Connector will default any property that is not present when setting the connection properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getConnectionProperties in interface IServerConnection2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionProperties

public void setConnectionProperties(IPropSet ppiProperties)
                             throws IOException,
                                    AutomationException

Properties for the server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setConnectionProperties in interface IServerConnection2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlugIn

public IPlugin getPlugIn()
                  throws IOException,
                         AutomationException

Data link plugin information for the server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getPlugIn in interface IServerConnection2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackingServicesList

public Object getTrackingServicesList()
                               throws IOException,
                                      AutomationException

List of tracking services.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getTrackingServicesList in interface IServerConnection2

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackingService

public ITrackingServiceDef getTrackingService(String bstrName)
                                       throws IOException,
                                              AutomationException

Gets tracking service for the server connection.

Description

This method returns tracking service for the server connection specified by bstrName.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getTrackingService in interface IServerConnection2

Parameters:

bstrName - The bstrName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnTrackingService

public void returnTrackingService(ITrackingServiceDef piTrackingServiceDef)
                           throws IOException,
                                  AutomationException

Returns tracking service for the server connection.

Remarks

This method is not implemented in the current version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

returnTrackingService in interface IServerConnection2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerActions

public Object getServerActions(boolean bForEditing)
                        throws IOException,
                               AutomationException

Actions used on data in the server connection.

Description

This method returns actions used on data in the server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getServerActions in interface IServerConnection2

Parameters:

bForEditing - The bForEditing (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnServerActions

public void returnServerActions(boolean bSave,
                                Object piActionCollection)
                         throws IOException,
                                AutomationException

Actions used on data in the server connection.

Remarks

This method is not implemented in the current version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

returnServerActions in interface IServerConnection2

Parameters:

bSave - The bSave (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessageCount

public int getMessageCount()
                    throws IOException,
                           AutomationException

The count of messages ready to retrieve.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getMessageCount in interface ITxConnectionMessages

Returns:

The plNumberOfMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEventReadyHandle

public int getEventReadyHandle()
                        throws IOException,
                               AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getEventReadyHandle in interface ITxConnectionMessages

Returns:

The phReadyEvent (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextMessage

public IMessage nextMessage()
                     throws IOException,
                            AutomationException

Retrieves a message from the server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

nextMessage in interface ITxConnectionMessages

Returns:

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

Throws:

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 IOException,
                              AutomationException

getUnmarshalClass

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:

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 IOException,
                              AutomationException

getMarshalSizeMax

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:

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 IOException,
                             AutomationException

marshalInterface

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:

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 IOException,
                               AutomationException

unmarshalInterface

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

releaseMarshalData

public void releaseMarshalData(IStream pStm)
                        throws IOException,
                               AutomationException

releaseMarshalData

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

releaseMarshalData in interface IMarshal

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.

disconnectObject

public void disconnectObject(int dwReserved)
                      throws IOException,
                             AutomationException

disconnectObject

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

disconnectObject in interface IMarshal

Parameters:

dwReserved - The dwReserved (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

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.

enumConnectionPoints

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

enumConnectionPoints

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

findConnectionPoint

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReceivedMessageCount

public Object getReceivedMessageCount()
                               throws IOException,
                                      AutomationException

Indicates total number of messages received.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getReceivedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPulledMessageCount

public Object getPulledMessageCount()
                             throws IOException,
                                    AutomationException

Indicates total number of messages pulled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getPulledMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDiscardedMessageCount

public Object getDiscardedMessageCount()
                                throws IOException,
                                       AutomationException

Indicates total number of messages discarded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getDiscardedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentDiscardedMessageCount

public Object getCurrentDiscardedMessageCount()
                                       throws IOException,
                                              AutomationException

Indicates current number of messages discarded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getCurrentDiscardedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueuedMessageCount

public Object getQueuedMessageCount()
                             throws IOException,
                                    AutomationException

Indicates total number of messages queued.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getQueuedMessageCount in interface IConnectionStatistics

Returns:

A Variant

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