com.esri.arcgis.trackinganalyst
Interface IAction

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ActionBase, ActionCollection, FilterAction, IActionProxy, TagAction

public interface IAction

extends java.io.Serializable

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

Product Availability

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

Description

The IAction interface describes the standard methods and properties needed for the action processor to identify the object as a valid action object. This interfaces provide a structured way for actions to be configured and processed within the action processor engine.

Method Summary

void	clearCounts() Clears all the internal counters for this action.
void	evaluate(java.lang.Object piObject, java.lang.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.
java.lang.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.
java.lang.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.
java.lang.String	getName() Developer-given name of the object.
int	getProcessedCount() Number of times this action has returned S_ACTIONPROCESSOR_MSG_PROCESSED.
java.lang.String	getRulesDescription() Describes what the action will do.
int	getStopProcessingCount() Number of times this action has returned S_ACTIONPROCESSOR_MSG_STOPPROCESSING.
java.lang.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 whether or not 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(java.lang.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(java.lang.String pbstrLabel) Allows user to specify or retreive tha label name for this action.
void	setStopProcessing(boolean pbvarStopProcessing) Indicates whether or not the processing engine should stop processing further actions in the action list after this action finishes processing.

Method Detail

getVersion

public double getVersion()
                  throws java.io.IOException,
                         AutomationException

Allows user to retrieve the version number for this action.

Description

This property allows the user to retrieve the version number for this action.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Developer-given name of the object.

Description

The name property is a developer given name of the object. This property cannot be changed and should be unique, such as the company ID or some other naming convention.

Returns:

The pbstrName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRulesDescription

public java.lang.String getRulesDescription()
                                     throws java.io.IOException,
                                            AutomationException

Describes what the action will do.

Description

This property describes what the action will do. This string should contain details about the configuration. This property is similar to the Microsoft Outlook rules "Rules Description" text.

Returns:

The pbstrRulesDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isContinueProcessing

public boolean isContinueProcessing()
                             throws java.io.IOException,
                                    AutomationException

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

Description

This property controls whether or not the processing engine should stop processing further actions in the action list after this action processes. The internal object must control the state of this property and must allow or return VARIANT_TRUE if this action did not successfully process the current action. The action processor must call Evaluate with a data object before this property is valid.

If the object successfully processed the data and internally it has been told to stop processing further actions, then the return value should be VARIANT_FALSE signifying to the action processor to stop processing actions.

Note: This property is not a copy of the property put_StopProcessing. The StopProcessing or write version simply enables whether or not this property is processed or returns a VARIANT_FALSE. If the StopProcessing property is false then this property is always TRUE. Otherwise the last Evaluate call determines the state.

Returns:

The pbvarContinueProcessing

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAlias

public java.lang.String getAlias()
                          throws java.io.IOException,
                                 AutomationException

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

Description

This property allows the user to specify or retrieve the alias name for this action.

Returns:

The pbstrAlias

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAlias

public void setAlias(java.lang.String pbstrAlias)
              throws java.io.IOException,
                     AutomationException

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

Description

This property allows the user to specify or retrieve the alias name for this action.

Parameters:

pbstrAlias - The pbstrAlias (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabel

public java.lang.String getLabel()
                          throws java.io.IOException,
                                 AutomationException

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

Description

This property allows the user to specify or retrieve the label name for this action.

Returns:

The pbstrLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(java.lang.String pbstrLabel)
              throws java.io.IOException,
                     AutomationException

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

Description

This property allows the user to specify or retrieve the label name for this action.

Parameters:

pbstrLabel - The pbstrLabel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public java.lang.String getType()
                         throws java.io.IOException,
                                AutomationException

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

Description

The type property allows a user to obtain a string describing the type of action object. This is generally a one word description.

Returns:

The pbstrType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException

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

Returns:

The pbvarIsEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsEnabled

public void setIsEnabled(boolean pbvarIsEnabled)
                  throws java.io.IOException,
                         AutomationException

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

Parameters:

pbvarIsEnabled - The pbvarIsEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStopProcessing

public void setStopProcessing(boolean pbvarStopProcessing)
                       throws java.io.IOException,
                              AutomationException

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

Description

This property controls whether or not the processing engine should stop processing further actions in the action list after this action processes. This enables the ContinueProcessing property to return a VARIANT_FALSE if no further processing should take place.

Parameters:

pbvarStopProcessing - The pbvarStopProcessing (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

evaluate

public void evaluate(java.lang.Object piObject,
                     java.lang.Object[] pvarReturnedObjects)
              throws java.io.IOException,
                     AutomationException

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

Description

This method provides the entry point for the action processor to evaluate the data that is undergoing processing. This method takes a variant that is an object that implement either a IDatamessage or a IFeature interface.

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isStopProcessing

public boolean isStopProcessing()
                         throws java.io.IOException,
                                AutomationException

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

Description

This property controls whether or not the processing engine should stop processing further actions in the action list after this action processes. This enables the ContinueProcessing property to return a VARIANT_FALSE if no furtherprocessing should take place.

Returns:

The pbvarStopProcessing

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEvaluationCount

public int getEvaluationCount()
                       throws java.io.IOException,
                              AutomationException

Number of times this action has been evaluated.

Description

This property is a count of the number of times this action has been evaluated.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStopProcessingCount

public int getStopProcessingCount()
                           throws java.io.IOException,
                                  AutomationException

Number of times this action has returned S_ACTIONPROCESSOR_MSG_STOPPROCESSING.

Description

This property counts the number of times this action has returned S_ACTIONPROCESSOR_MSG_STOPPROCESSING.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFilteredCount

public int getFilteredCount()
                     throws java.io.IOException,
                            AutomationException

Number of times this action has returned S_ACTIONPROCESSOR_MSG_FILTERED.

Description

This property is a count of the number of times this action has returned S_ACTIONPROCESSOR_MSG_FILTERED.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getModifiedCount

public int getModifiedCount()
                     throws java.io.IOException,
                            AutomationException

Number of times this action has returned S_ACTIONPROCESSOR_MSG_MODIFIED.

Description

This property is a count of the number of times this action has returned S_ACTIONPROCESSOR_MSG_MODIFIED.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProcessedCount

public int getProcessedCount()
                      throws java.io.IOException,
                             AutomationException

Number of times this action has returned S_ACTIONPROCESSOR_MSG_PROCESSED.

Description

This property is a count of the number of times this action has returned S_ACTIONPROCESSOR_MSG_PROCESSED.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearCounts

public void clearCounts()
                 throws java.io.IOException,
                        AutomationException

Clears all the internal counters for this action.

Description

This property clears all the internal counters for this action.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActionCategory

public int getActionCategory()
                      throws java.io.IOException,
                             AutomationException

Indicates the type of action to be applied to data.

Returns:

A com.esri.arcgis.trackinganalyst.enumActionCategory constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActionCategory

public void setActionCategory(int pVal)
                       throws java.io.IOException,
                              AutomationException

Indicates the type of action to be applied to data.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.