com.esri.arcgis.trackinganalyst
Interface IActionProcessor

All Superinterfaces:
Serializable
All Known Implementing Classes:
ActionProcessor

public interface IActionProcessor
extends Serializable

Provides access to the methods and properties needed to manage and process a list of actions.

Description

This class defines the Action Processor COM Object for the IDL file. See the ActionProcessor class for a description of its purpose.

Product Availability

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


Method Summary
 void checkLayers()
          Checks for deleted Layers and disables affected actions.
 void clearQueue()
          Purges the processing queue and terminates the processing of queued messages.
 IActionCollection getActions()
          Allows access to the action processor's action collection.
 int getProcessorWaitTimeOut()
          Provides a configurable timeout for waiting to be able to process data objects, defaulted to 5 seconds.
 boolean isExcludeRealtimeActions()
          Indicates if real-time actions are excluded from appearing on the interface.
 boolean isSuspended()
          Indicates whether the action processor will process any new data objects or any queued data objects.
 void processData(Object piObject, boolean bQueueProcessing, Object pvarReturnedObjects)
          Takes an object as a parameter and runs it through an action list.
 void setActionsByRef(IActionCollection piActions)
          Allows access to the action processor's action collection.
 void setExcludeRealtimeActions(boolean pbvarExclude)
          Indicates if real-time actions are excluded from appearing on the interface.
 void setProcessorWaitTimeOut(int plProcessorWaitTimeOut)
          Provides a configurable timeout for waiting to be able to process data objects, defaulted to 5 seconds.
 void setSuspended(boolean pbvarSuspended)
          Indicates whether the action processor will process any new data objects or any queued data objects.
 

Method Detail

processData

void processData(Object piObject,
                 boolean bQueueProcessing,
                 Object pvarReturnedObjects)
                 throws IOException,
                        AutomationException
Takes an object as a parameter and runs it through an action list.

Description

The ProcessData method takes an object as a parameter and runs it through an action list. The object can be queued if desired and an internal thread will run the object through the action list when able.

When this method is called without requesting that the object is to be queued, the third parameter will contain the potentially modified copy of the object or modified object. One special case for this returned object is when the action list contains a filter action. In this case, if the object is filtered out then the return is NULL.

Product Availability

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

Parameters:
piObject - A reference to another Object (IUnknown) (in)
bQueueProcessing - The bQueueProcessing (in)
pvarReturnedObjects - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearQueue

void clearQueue()
                throws IOException,
                       AutomationException
Purges the processing queue and terminates the processing of queued messages.

Description

This method purges the processing queue thus terminating the processing of queued messages.

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.

isSuspended

boolean isSuspended()
                    throws IOException,
                           AutomationException
Indicates whether the action processor will process any new data objects or any queued data objects.

Description

The suspended property controls whether the action processor will process any new data objects or any queued data objects. New data objects do not queue up when the processor is suspended rather they just fall through the processor un processed.

Product Availability

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

Returns:
The pbvarSuspended
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSuspended

void setSuspended(boolean pbvarSuspended)
                  throws IOException,
                         AutomationException
Indicates whether the action processor will process any new data objects or any queued data objects.

Description

The suspended property controls whether the action processor will process any new data objects or any queued data objects. New data objects do not queue up when the processor is suspended rather they just fall through the processor un processed.

Product Availability

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

Parameters:
pbvarSuspended - The pbvarSuspended (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActions

IActionCollection getActions()
                             throws IOException,
                                    AutomationException
Allows access to the action processor's action collection.

Description

This property allows access to the Action Processor's Action Collection. The action collection contains all actions that the processor is processing.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.trackinganalyst.IActionCollection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActionsByRef

void setActionsByRef(IActionCollection piActions)
                     throws IOException,
                            AutomationException
Allows access to the action processor's action collection.

Description

This property allows access to the Action Processors Action Collection. The action collection contains all actions that the processor is processing. The developer is responsible for ensuring that the action collection is not changed while another thread is processing a data object.

Product Availability

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

Parameters:
piActions - A reference to a com.esri.arcgis.trackinganalyst.IActionCollection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProcessorWaitTimeOut

int getProcessorWaitTimeOut()
                            throws IOException,
                                   AutomationException
Provides a configurable timeout for waiting to be able to process data objects, defaulted to 5 seconds.

Description

This property provides a configurable timeout for waiting to be able to process data objects. The default value for this setting is 5 seconds.

Product Availability

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

Returns:
The plProcessorWaitTimeOut
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProcessorWaitTimeOut

void setProcessorWaitTimeOut(int plProcessorWaitTimeOut)
                             throws IOException,
                                    AutomationException
Provides a configurable timeout for waiting to be able to process data objects, defaulted to 5 seconds.

Description

This property provides a configurable timeout for waiting to be able to process data objects. The default value for this setting is 5 seconds.

Product Availability

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

Parameters:
plProcessorWaitTimeOut - The plProcessorWaitTimeOut (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExcludeRealtimeActions

boolean isExcludeRealtimeActions()
                                 throws IOException,
                                        AutomationException
Indicates if real-time actions are excluded from appearing on the interface.

Product Availability

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

Returns:
The pbvarExclude
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcludeRealtimeActions

void setExcludeRealtimeActions(boolean pbvarExclude)
                               throws IOException,
                                      AutomationException
Indicates if real-time actions are excluded from appearing on the interface.

Product Availability

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

Parameters:
pbvarExclude - The pbvarExclude (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkLayers

void checkLayers()
                 throws IOException,
                        AutomationException
Checks for deleted Layers and disables affected actions.

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.