com.esri.arcgis.carto
Interface IActionProcessor

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ActionProcessor, IActionProcessorProxy

public interface IActionProcessor
extends java.io.Serializable

COM Interface 'IActionProcessor'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to the methods and properties needed to manage and process a list of actions.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDcc018a6f_24fb_11d4_b34c_00104ba2abcc
static int	xxDummy Deprecated. Internal use only

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(java.lang.Object piObject, boolean bQueueProcessing, java.lang.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.

Field Detail

IIDcc018a6f_24fb_11d4_b34c_00104ba2abcc

static final int IIDcc018a6f_24fb_11d4_b34c_00104ba2abcc

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

processData

void processData(java.lang.Object piObject,
                 boolean bQueueProcessing,
                 java.lang.Object pvarReturnedObjects)
                 throws java.io.IOException,
                        AutomationException

Takes an object as a parameter and runs it through an action list.

Parameters:

piObject - A reference to another Object (IUnknown) (in)

bQueueProcessing - The bQueueProcessing (in)

pvarReturnedObjects - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearQueue

void clearQueue()
                throws java.io.IOException,
                       AutomationException

Purges the processing queue and terminates the processing of queued messages.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSuspended

boolean isSuspended()
                    throws java.io.IOException,
                           AutomationException

Indicates whether the action processor will process any new data objects or any queued data objects.

Returns:

The pbvarSuspended

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSuspended

void setSuspended(boolean pbvarSuspended)
                  throws java.io.IOException,
                         AutomationException

Indicates whether the action processor will process any new data objects or any queued data objects.

Parameters:

pbvarSuspended - The pbvarSuspended (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActions

IActionCollection getActions()
                             throws java.io.IOException,
                                    AutomationException

Allows access to the action processor's action collection.

Returns:

A reference to a com.esri.arcgis.carto.IActionCollection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActionsByRef

void setActionsByRef(IActionCollection piActions)
                     throws java.io.IOException,
                            AutomationException

Allows access to the action processor's action collection.

Parameters:

piActions - A reference to a com.esri.arcgis.carto.IActionCollection (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProcessorWaitTimeOut

int getProcessorWaitTimeOut()
                            throws java.io.IOException,
                                   AutomationException

Provides a configurable timeout for waiting to be able to process data objects, defaulted to 5 seconds.

Returns:

The plProcessorWaitTimeOut

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProcessorWaitTimeOut

void setProcessorWaitTimeOut(int plProcessorWaitTimeOut)
                             throws java.io.IOException,
                                    AutomationException

Provides a configurable timeout for waiting to be able to process data objects, defaulted to 5 seconds.

Parameters:

plProcessorWaitTimeOut - The plProcessorWaitTimeOut (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExcludeRealtimeActions

boolean isExcludeRealtimeActions()
                                 throws java.io.IOException,
                                        AutomationException

Indicates if real-time actions are excluded from appearing on the interface.

Returns:

The pbvarExclude

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludeRealtimeActions

void setExcludeRealtimeActions(boolean pbvarExclude)
                               throws java.io.IOException,
                                      AutomationException

Indicates if real-time actions are excluded from appearing on the interface.

Parameters:

pbvarExclude - The pbvarExclude (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkLayers

void checkLayers()
                 throws java.io.IOException,
                        AutomationException

Checks for deleted Layers and disables affected actions.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.