com.esri.arcgis.trackinganalyst
Interface IPlugInConfigure

All Superinterfaces:

Serializable

All Known Implementing Classes:

PlugInConfigure

public interface IPlugInConfigure
extends Serializable

Provides access to methods and properties needed to configure and manage server based data links.

Product Availability

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

Method Summary

void	configure(IPlugin piServerConnection) Configures the data link.
String	getConfigurationString() Indicates value of the configuration string.
String	getDescription() Description of the data link and its configuration.
String	getName() Name of the data link.
String	getPlugInType() Indicates type of data link being used.
void	setConfigurationString(String pbstrConfigurationString) Indicates value of the configuration string.
void	startPlugIn(IPlugin piServerConnection) Starts the data link plugin.
void	stopPlugIn(IPlugin piServerConnection, int nShutdownTimeOutInSeconds) Stops the data link plug in.

Method Detail

getPlugInType

String getPlugInType()
                     throws IOException,
                            AutomationException

Indicates type of data link being used.

Product Availability

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

Returns:

The pbstrPlugInType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationString

String getConfigurationString()
                              throws IOException,
                                     AutomationException

Indicates value of the configuration string.

Product Availability

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

Returns:

The pbstrConfigurationString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConfigurationString

void setConfigurationString(String pbstrConfigurationString)
                            throws IOException,
                                   AutomationException

Indicates value of the configuration string.

Product Availability

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

Parameters:

pbstrConfigurationString - The pbstrConfigurationString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

configure

void configure(IPlugin piServerConnection)
               throws IOException,
                      AutomationException

Configures the data link.

Product Availability

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

Parameters:

piServerConnection - A reference to a com.esri.arcgis.trackinganalyst.IPlugin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Description of the data link and its configuration.

Product Availability

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

Returns:

The pbstrDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

Name of the data link.

Product Availability

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

Returns:

The pbstrName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startPlugIn

void startPlugIn(IPlugin piServerConnection)
                 throws IOException,
                        AutomationException

Starts the data link plugin.

Product Availability

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

Parameters:

piServerConnection - A reference to a com.esri.arcgis.trackinganalyst.IPlugin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopPlugIn

void stopPlugIn(IPlugin piServerConnection,
                int nShutdownTimeOutInSeconds)
                throws IOException,
                       AutomationException

Stops the data link plug in.

Product Availability

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

Parameters:

piServerConnection - A reference to a com.esri.arcgis.trackinganalyst.IPlugin (in)

nShutdownTimeOutInSeconds - The nShutdownTimeOutInSeconds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.