com.esri.arcgis.trackinganalyst
Interface ITxConnectorEvents

All Superinterfaces:

Serializable

All Known Implementing Classes:

ITxConnectorEventsProxy

public interface ITxConnectorEvents
extends Serializable

Provides access to methods that provide notification about tracking connection events.

Product Availability

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

Method Summary

void	onConnectorConnect(String bstrUserName, String bstrPassword) Notification that the Connect method has been called.
void	onConnectorDisconnect() Notification that the Disconnect method has been called.
void	onConnectorMessage(IMessage piMessage) Notification that a Request has been issued to send a Message provided in the Argument.
void	onConnectorProperties(boolean bvarSetProperties, IPropSet piConnectionProperties) Requests that the Connector Properties are to be set or retrieved depending on whether SetProperties argument is true or false.
void	onDisableMessages() Notification that a change has been made to dis-allow a message definition.
void	onEnableMessages() Notification that a change has been made to allow a new message definition.

Method Detail

onConnectorMessage

void onConnectorMessage(IMessage piMessage)
                        throws IOException,
                               AutomationException

Notification that a Request has been issued to send a Message provided in the Argument.

Product Availability

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

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.

onConnectorDisconnect

void onConnectorDisconnect()
                           throws IOException,
                                  AutomationException

Notification that the Disconnect method has been called.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onConnectorConnect

void onConnectorConnect(String bstrUserName,
                        String bstrPassword)
                        throws IOException,
                               AutomationException

Notification that the Connect method has been called.

Product Availability

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

Parameters:

bstrUserName - The bstrUserName (in)

bstrPassword - The bstrPassword (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onConnectorProperties

void onConnectorProperties(boolean bvarSetProperties,
                           IPropSet piConnectionProperties)
                           throws IOException,
                                  AutomationException

Requests that the Connector Properties are to be set or retrieved depending on whether SetProperties argument is true or false.

Product Availability

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

Parameters:

bvarSetProperties - The bvarSetProperties (in)

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

onEnableMessages

void onEnableMessages()
                      throws IOException,
                             AutomationException

Notification that a change has been made to allow a new message definition. Essentially this lets the parent object know that the data filtering has changed.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDisableMessages

void onDisableMessages()
                       throws IOException,
                              AutomationException

Notification that a change has been made to dis-allow a message definition. Essentially this lets the parent object know that the data filtering has changed.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.