com.esri.arcgis.carto
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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.carto.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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

piActions - A reference to a com.esri.arcgis.carto.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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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.

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.

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.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.