com.esri.arcgis.trackinganalyst
Interface IActionLookupSupport

All Superinterfaces:

Serializable

All Known Implementing Classes:

ActionEnvironment

public interface IActionLookupSupport
extends Serializable

Provides access to properties and methods needed to support lookup table.

Product Availability

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

Method Summary

void	close() Close the Action Environment.
String	expandQuery(String bstrQuery) Insert lookup table values into query string.
IActionLookupSources	getActionLookupSources() Lookup data sources.
int	getRefreshRate() RefreshRate for lookup tables.
IEnumVARIANT	listDataValues(String bstrLookupTableName, String bstrFieldName, int[] peFieldType) Retrieve list of data values from lookup table.
IEnumBSTR	listFields(String bstrLookupTableName) Retrieve list of field names from lookup table.
void	readDataValues(String bstrLookupTableName) Read data values from lookup table.
void	register(IActionProcessor actionProcessor) Register an Action Processor.
void	setRefreshRate(int pMinutes) RefreshRate for lookup tables.
void	unRegister(IActionProcessor actionProcessor) Unregister an Action Processor.

Method Detail

getActionLookupSources

IActionLookupSources getActionLookupSources()
                                            throws IOException,
                                                   AutomationException

Lookup data sources.

Description

This property retrieves lookup data sources. The returned ActionLookupSources objects contains information about how to read and what contents are stored in an action lookup repository. This repository can be comma delimited text files or geodatabase table.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRefreshRate

void setRefreshRate(int pMinutes)
                    throws IOException,
                           AutomationException

RefreshRate for lookup tables.

Product Availability

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

Parameters:

pMinutes - The pMinutes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRefreshRate

int getRefreshRate()
                   throws IOException,
                          AutomationException

RefreshRate for lookup tables.

Description

This property indicates the refresh rate for lookup tables.

Product Availability

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

Returns:

The pMinutes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readDataValues

void readDataValues(String bstrLookupTableName)
                    throws IOException,
                           AutomationException

Read data values from lookup table.

Product Availability

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

Parameters:

bstrLookupTableName - The bstrLookupTableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandQuery

String expandQuery(String bstrQuery)
                   throws IOException,
                          AutomationException

Insert lookup table values into query string.

Product Availability

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

Parameters:

bstrQuery - The bstrQuery (in)

Returns:

The pExpandedQuery

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listDataValues

IEnumVARIANT listDataValues(String bstrLookupTableName,
                            String bstrFieldName,
                            int[] peFieldType)
                            throws IOException,
                                   AutomationException

Retrieve list of data values from lookup table.

Product Availability

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

Parameters:

bstrLookupTableName - The bstrLookupTableName (in)

bstrFieldName - The bstrFieldName (in)

peFieldType - A com.esri.arcgis.geodatabase.esriFieldType constant (out: use single element array)

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.IEnumVARIANT

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listFields

IEnumBSTR listFields(String bstrLookupTableName)
                     throws IOException,
                            AutomationException

Retrieve list of field names from lookup table.

Product Availability

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

Parameters:

bstrLookupTableName - The bstrLookupTableName (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

close

void close()
           throws IOException,
                  AutomationException

Close the Action Environment.

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.

register

void register(IActionProcessor actionProcessor)
              throws IOException,
                     AutomationException

Register an Action Processor.

Product Availability

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

Parameters:

actionProcessor - A reference to a com.esri.arcgis.carto.IActionProcessor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unRegister

void unRegister(IActionProcessor actionProcessor)
                throws IOException,
                       AutomationException

Unregister an Action Processor.

Product Availability

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

Parameters:

actionProcessor - A reference to a com.esri.arcgis.carto.IActionProcessor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.