com.esri.arcgis.trackinganalyst
Class PlugInConfigure

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IPlugInConfigure, Serializable

public class PlugInConfigure
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPlugInConfigure

Implements IPlugInConfigure interface to configure and manage server based data links.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

PlugInConfigure()
Constructs a PlugInConfigure using ArcGIS Engine.

PlugInConfigure(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PlugInConfigure thePlugInConfigure = (PlugInConfigure) obj;

Method Summary

void	configure(IPlugin piServerConnection) Configures the data link.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

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

PlugInConfigure

public PlugInConfigure()
                throws IOException,
                       UnknownHostException

Constructs a PlugInConfigure using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

PlugInConfigure

public PlugInConfigure(Object obj)
                throws IOException

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

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

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

getPlugInType

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

Specified by:

getPlugInType in interface IPlugInConfigure

Returns:

The pbstrPlugInType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationString

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

Specified by:

getConfigurationString in interface IPlugInConfigure

Returns:

The pbstrConfigurationString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConfigurationString

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

Specified by:

setConfigurationString in interface IPlugInConfigure

Parameters:

pbstrConfigurationString - The pbstrConfigurationString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

configure

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

Specified by:

configure in interface IPlugInConfigure

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

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

Specified by:

getDescription in interface IPlugInConfigure

Returns:

The pbstrDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

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

Specified by:

getName in interface IPlugInConfigure

Returns:

The pbstrName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startPlugIn

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

Specified by:

startPlugIn in interface IPlugInConfigure

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

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

Specified by:

stopPlugIn in interface IPlugInConfigure

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.