com.esri.arcgis.carto
Interface IAction

All Superinterfaces:

Serializable

All Known Implementing Classes:

ActionBase, ActionCollection, DataModificationAction, DataPartitionAction, DataSummaryAction, EmailAlertAction, FilterAction, HighlightSuppressionAction, TagAction

public interface IAction
extends Serializable

Provides access to properties and methods needed to manage general actions settings and funcationality.

Product Availability

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

Method Summary

void	clearCounts() Clears all the internal counters for this action.
void	evaluate(Object piObject, Object[] pvarReturnedObjects) Takes an input object and evaluates the object based on predefined criteria.
int	getActionCategory() Indicates the type of action to be applied to data.
String	getAlias() Allows user to specify or retrieve the alias name for this action.
int	getEvaluationCount() Number of times this action has been evaluated.
int	getFilteredCount() Number of times this action has returned S_ACTIONPROCESSOR_MSG_FILTERED.
String	getLabel() Allows user to specify or retreive tha label name for this action.
int	getModifiedCount() Number of times this action has returned S_ACTIONPROCESSOR_MSG_MODIFIED.
String	getName() Developer-given name of the object.
int	getProcessedCount() Number of times this action has returned S_ACTIONPROCESSOR_MSG_PROCESSED.
String	getRulesDescription() Describes what the action will do.
int	getStopProcessingCount() Number of times this action has returned S_ACTIONPROCESSOR_MSG_STOPPROCESSING.
String	getType() Allows user to obtain a string describing the type of action object.
double	getVersion() Allows user to retrieve the version number for this action.
boolean	isContinueProcessing() Indicates whether or not the processing engine should stop processing further actions in the action list after this action finishes processing.
boolean	isEnabled() Indicates whether or not an action in the action list is enabled for processing.
boolean	isStopProcessing() Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.
void	setActionCategory(int pVal) Indicates the type of action to be applied to data.
void	setAlias(String pbstrAlias) Allows user to specify or retrieve the alias name for this action.
void	setIsEnabled(boolean pbvarIsEnabled) Indicates whether or not an action in the action list is enabled for processing.
void	setLabel(String pbstrLabel) Allows user to specify or retreive tha label name for this action.
void	setStopProcessing(boolean pbvarStopProcessing) Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.

Method Detail

getVersion

double getVersion()
                  throws IOException,
                         AutomationException

Allows user to retrieve the version number for this action.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

Developer-given name of the object.

Product Availability

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

Returns:

The pbstrName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRulesDescription

String getRulesDescription()
                           throws IOException,
                                  AutomationException

Describes what the action will do.

Product Availability

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

Returns:

The pbstrRulesDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isContinueProcessing

boolean isContinueProcessing()
                             throws IOException,
                                    AutomationException

Indicates whether or not the processing engine should stop processing further actions in the action list after this action finishes processing.

Product Availability

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

Returns:

The pbvarContinueProcessing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlias

String getAlias()
                throws IOException,
                       AutomationException

Allows user to specify or retrieve the alias name for this action.

Product Availability

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

Returns:

The pbstrAlias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlias

void setAlias(String pbstrAlias)
              throws IOException,
                     AutomationException

Allows user to specify or retrieve the alias name for this action.

Product Availability

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

Parameters:

pbstrAlias - The pbstrAlias (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

String getLabel()
                throws IOException,
                       AutomationException

Allows user to specify or retreive tha label name for this action.

Product Availability

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

Returns:

The pbstrLabel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(String pbstrLabel)
              throws IOException,
                     AutomationException

Allows user to specify or retreive tha label name for this action.

Product Availability

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

Parameters:

pbstrLabel - The pbstrLabel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

String getType()
               throws IOException,
                      AutomationException

Allows user to obtain a string describing the type of action object.

Product Availability

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

Returns:

The pbstrType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates whether or not an action in the action list is enabled for processing.

Product Availability

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

Returns:

The pbvarIsEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsEnabled

void setIsEnabled(boolean pbvarIsEnabled)
                  throws IOException,
                         AutomationException

Indicates whether or not an action in the action list is enabled for processing.

Product Availability

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

Parameters:

pbvarIsEnabled - The pbvarIsEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStopProcessing

void setStopProcessing(boolean pbvarStopProcessing)
                       throws IOException,
                              AutomationException

Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.

Product Availability

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

Parameters:

pbvarStopProcessing - The pbvarStopProcessing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

evaluate

void evaluate(Object piObject,
              Object[] pvarReturnedObjects)
              throws IOException,
                     AutomationException

Takes an input object and evaluates the object based on predefined criteria.

Product Availability

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

Parameters:

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

pvarReturnedObjects - A Variant (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStopProcessing

boolean isStopProcessing()
                         throws IOException,
                                AutomationException

Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.

Product Availability

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

Returns:

The pbvarStopProcessing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEvaluationCount

int getEvaluationCount()
                       throws IOException,
                              AutomationException

Number of times this action has been evaluated.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStopProcessingCount

int getStopProcessingCount()
                           throws IOException,
                                  AutomationException

Number of times this action has returned S_ACTIONPROCESSOR_MSG_STOPPROCESSING.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilteredCount

int getFilteredCount()
                     throws IOException,
                            AutomationException

Number of times this action has returned S_ACTIONPROCESSOR_MSG_FILTERED.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModifiedCount

int getModifiedCount()
                     throws IOException,
                            AutomationException

Number of times this action has returned S_ACTIONPROCESSOR_MSG_MODIFIED.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProcessedCount

int getProcessedCount()
                      throws IOException,
                             AutomationException

Number of times this action has returned S_ACTIONPROCESSOR_MSG_PROCESSED.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearCounts

void clearCounts()
                 throws IOException,
                        AutomationException

Clears all the internal counters for this action.

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.

getActionCategory

int getActionCategory()
                      throws IOException,
                             AutomationException

Indicates the type of action to be applied to data.

Product Availability

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

Returns:

A com.esri.arcgis.carto.enumActionCategory constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActionCategory

void setActionCategory(int pVal)
                       throws IOException,
                              AutomationException

Indicates the type of action to be applied to data.

Product Availability

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

Parameters:

pVal - A com.esri.arcgis.carto.enumActionCategory constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.