Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Interface IAction

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ActionBase, ActionCollection, DataModificationAction, DataPartitionAction, DataSummaryAction, EmailAlertAction, FilterAction, HighlightSuppressionAction, IActionProxy, TagAction
public interface IAction
extends java.io.Serializable

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

Description: 'Provides access to properties and methods needed to manage general actions settings and funcationality.' 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 IIDcc018a6e_24fb_11d4_b34c_00104ba2abcc
           
static int xxDummy
          Deprecated. Internal use only
 
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 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(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 if the processing engine should stop processing further actions in the action list after this action finishes processing.
 

Field Detail

IIDcc018a6e_24fb_11d4_b34c_00104ba2abcc

static final int IIDcc018a6e_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

getVersion

double getVersion()
                  throws java.io.IOException,
                         AutomationException
Allows 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

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Developer-given name of the object.

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

getRulesDescription

java.lang.String getRulesDescription()
                                     throws java.io.IOException,
                                            AutomationException
Describes what the action will do.

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

isContinueProcessing

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.

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

getAlias

java.lang.String getAlias()
                          throws java.io.IOException,
                                 AutomationException
Allows 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

void setAlias(java.lang.String pbstrAlias)
              throws java.io.IOException,
                     AutomationException
Allows 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

java.lang.String getLabel()
                          throws java.io.IOException,
                                 AutomationException
Allows user to specify or retreive tha 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

void setLabel(java.lang.String pbstrLabel)
              throws java.io.IOException,
                     AutomationException
Allows user to specify or retreive tha 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

java.lang.String getType()
                         throws java.io.IOException,
                                AutomationException
Allows user to obtain a string describing the type of action object.

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

isEnabled

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

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

void setStopProcessing(boolean pbvarStopProcessing)
                       throws java.io.IOException,
                              AutomationException
Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.

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

evaluate

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.

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

boolean isStopProcessing()
                         throws java.io.IOException,
                                AutomationException
Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.

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

getEvaluationCount

int getEvaluationCount()
                       throws java.io.IOException,
                              AutomationException
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

int getStopProcessingCount()
                           throws java.io.IOException,
                                  AutomationException
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

int getFilteredCount()
                     throws java.io.IOException,
                            AutomationException
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

int getModifiedCount()
                     throws java.io.IOException,
                            AutomationException
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

int getProcessedCount()
                      throws java.io.IOException,
                             AutomationException
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

void clearCounts()
                 throws java.io.IOException,
                        AutomationException
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

int getActionCategory()
                      throws java.io.IOException,
                             AutomationException
Indicates the type of action to be applied to data.

Returns:
A com.esri.arcgis.carto.enumActionCategory constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActionCategory

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.carto.enumActionCategory constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD