com.esri.arcgis.trackinganalyst
Class ActionCollection

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.ActionCollection
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, ISupportErrorInfo, IAction, IActionCollection, IActionCollection2, IActionState, IActionUpdate, Externalizable, Serializable

public class ActionCollection
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IActionCollection, IActionCollection2, ISupportErrorInfo, IAction, IPersistStream, IClone, IActionUpdate, IActionState, Externalizable

The Action Collection object is a container of actions.

Description

This class is a container of tracking action objects. The Action processor object contains exactly one ActionCollection. Since this object is itself a tracking action it forwards requests to evaluate to each action object in its collection.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ActionCollection()
          Constructs a ActionCollection using ArcGIS Engine.
ActionCollection(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ActionCollection theActionCollection = (ActionCollection) obj;
 
Method Summary
 boolean actionNameExists(String bstrName)
          Checks if an action within the collection exists with the specified name.
 void add(IAction piAction, int nIndex)
          Adds an action to the collection.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void checkLayers(boolean bRebuildGeometry)
          Checks for deleted Layers and disables affected actions.
 void clearCounts()
          Clears all the internal counters for this action.
 boolean dependsUponFeatureClass(IFeatureClass piFeatureClass)
          Indicates if a contained action depends upon the specified feature class.
 boolean disableActionsUsingLayer(ILayer piLayer)
          Disables all action using the specified layer for location trigger.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void evaluate(Object piObject, Object[] pvarReturnedObjects)
          Takes an input object and evaluates the object based on predefined criteria.
 int find(IAction piAction)
          Finds an action within the collection.
 IAction getAction(int nIndex)
          Retrieves the action at the specified index.
 int getActionCategory()
          Indicates the type of action to be applied to data.
 int getActionCount()
          Total number of actions.
 String getAlias()
          Allows user to specify or retrieve the alias name for this action.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getCount()
          Number of objects in the collection.
 int getEnabledActionCount()
          Number of enabled actions.
 int getEvaluationCount()
          Number of times this action has been evaluated.
 int getExclusionCategory()
          Action category to be excluded from processing.
 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 getMaximumDepth()
          Maximum number of nested action levels to be processed.
 int getModifiedCount()
          Number of times this action has returned S_ACTIONPROCESSOR_MSG_MODIFIED.
 String getName()
          Developer-given name of the object.
 int getNextActionNumber()
          Gives next sequential number for assigning names to actions.
 int getProcessedCount()
          Number of times this action has returned S_ACTIONPROCESSOR_MSG_PROCESSED.
 String getRulesDescription()
          Describes what the action will do.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 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.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isContinueProcessing()
          Indicates whether or not the processing engine should stop processing further actions in the action list after this action finishes processing.
 void isDirty()
          isDirty
 boolean isEnabled()
          Indicates whether or not an action in the action list is enabled for processing.
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isStopProcessing()
          Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.
 void load(IStream pstm)
          load
 void move(int nSourceIndex, int nDestinationIndex)
          Moves an action to a user-specified location in the collection.
 void readExternal(ObjectInput in)
           
 boolean reenableActionsUsingLayer(ILayer piLayer)
          Reenable all action using the specified layer for location trigger.
 void remove(int nIndex)
          Removes an action from the collection.
 void removeAll()
          Removes all actions from the index.
 void resetToDefaultState()
          Reset the State information to default.
 void save(IStream pstm, int fClearDirty)
          save
 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 setExclusionCategory(int pVal)
          Action category to be excluded from processing.
 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 setMaximumDepth(int pVal)
          Maximum number of nested action levels to be processed.
 void setNextActionNumber(int pVal)
          Gives next sequential number for assigning names to actions.
 void setStopProcessing(boolean pbvarStopProcessing)
          Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.
 void update()
          Notify a tracking action that lookup table values have changed.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ActionCollection

public ActionCollection()
                 throws IOException,
                        UnknownHostException
Constructs a ActionCollection using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ActionCollection

public ActionCollection(Object obj)
                 throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ActionCollection theActionCollection = (ActionCollection) obj;

Construct a ActionCollection using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ActionCollection.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

add

public void add(IAction piAction,
                int nIndex)
         throws IOException,
                AutomationException
Adds an action to the collection.

Description

This method allows a user to add an action to the Collection. The action will be added at the specified index. Specifying a large index value, such as 999999 will ensure the action is placed at the end of the list. This method will addref the received action before placing in the collection.

Product Availability

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

Specified by:
add in interface IActionCollection
Specified by:
add in interface IActionCollection2
Parameters:
piAction - A reference to a com.esri.arcgis.trackinganalyst.IAction (in)
nIndex - The nIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int nIndex)
            throws IOException,
                   AutomationException
Removes an action from the collection.

Description

This method allows a user to remove an action at the specified index. If the index specified is out of range an E_FAIL is returned otherwise a S_OK is returned on success. This method on success releases the action removed.

Product Availability

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

Specified by:
remove in interface IActionCollection
Specified by:
remove in interface IActionCollection2
Parameters:
nIndex - The nIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

move

public void move(int nSourceIndex,
                 int nDestinationIndex)
          throws IOException,
                 AutomationException
Moves an action to a user-specified location in the collection.

Description

This method allows the user to move an action in the collection. The from and to index allows the user to specify the location in the collection to move the action about. The behavior is to insert the moved action at the specified index moving the existing action at the move to index forward in the list thus adding one to its index.

Product Availability

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

Specified by:
move in interface IActionCollection
Specified by:
move in interface IActionCollection2
Parameters:
nSourceIndex - The nSourceIndex (in)
nDestinationIndex - The nDestinationIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException
Removes all actions from the index.

Description

This method removes all actions from the index using the remove method.

Product Availability

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

Specified by:
removeAll in interface IActionCollection
Specified by:
removeAll in interface IActionCollection2
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAction

public IAction getAction(int nIndex)
                  throws IOException,
                         AutomationException
Retrieves the action at the specified index.

Product Availability

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

Specified by:
getAction in interface IActionCollection
Specified by:
getAction in interface IActionCollection2
Parameters:
nIndex - The nIndex (in)
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IAction
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException
Number of objects in the collection.

Description

This method returns the number of objects in the collection.

Product Availability

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

Specified by:
getCount in interface IActionCollection
Specified by:
getCount in interface IActionCollection2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

find

public int find(IAction piAction)
         throws IOException,
                AutomationException
Finds an action within the collection.

Description

This method finds the specified action in the collection and returns the index of that action.

Product Availability

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

Specified by:
find in interface IActionCollection
Specified by:
find in interface IActionCollection2
Parameters:
piAction - A reference to a com.esri.arcgis.trackinganalyst.IAction (in)
Returns:
The pnIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumDepth

public int getMaximumDepth()
                    throws IOException,
                           AutomationException
Maximum number of nested action levels to be processed.

Product Availability

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

Specified by:
getMaximumDepth in interface IActionCollection
Specified by:
getMaximumDepth in interface IActionCollection2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumDepth

public void setMaximumDepth(int pVal)
                     throws IOException,
                            AutomationException
Maximum number of nested action levels to be processed.

Product Availability

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

Specified by:
setMaximumDepth in interface IActionCollection
Specified by:
setMaximumDepth in interface IActionCollection2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNextActionNumber

public int getNextActionNumber()
                        throws IOException,
                               AutomationException
Gives next sequential number for assigning names to actions.

Product Availability

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

Specified by:
getNextActionNumber in interface IActionCollection
Specified by:
getNextActionNumber in interface IActionCollection2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNextActionNumber

public void setNextActionNumber(int pVal)
                         throws IOException,
                                AutomationException
Gives next sequential number for assigning names to actions.

Product Availability

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

Specified by:
setNextActionNumber in interface IActionCollection
Specified by:
setNextActionNumber in interface IActionCollection2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExclusionCategory

public int getExclusionCategory()
                         throws IOException,
                                AutomationException
Action category to be excluded from processing.

Product Availability

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

Specified by:
getExclusionCategory in interface IActionCollection
Specified by:
getExclusionCategory in interface IActionCollection2
Returns:
A com.esri.arcgis.trackinganalyst.enumActionCategory constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExclusionCategory

public void setExclusionCategory(int pVal)
                          throws IOException,
                                 AutomationException
Action category to be excluded from processing.

Product Availability

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

Specified by:
setExclusionCategory in interface IActionCollection
Specified by:
setExclusionCategory in interface IActionCollection2
Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumActionCategory constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActionCount

public int getActionCount()
                   throws IOException,
                          AutomationException
Total number of actions.

Product Availability

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

Specified by:
getActionCount in interface IActionCollection
Specified by:
getActionCount in interface IActionCollection2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnabledActionCount

public int getEnabledActionCount()
                          throws IOException,
                                 AutomationException
Number of enabled actions.

Product Availability

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

Specified by:
getEnabledActionCount in interface IActionCollection
Specified by:
getEnabledActionCount in interface IActionCollection2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

dependsUponFeatureClass

public boolean dependsUponFeatureClass(IFeatureClass piFeatureClass)
                                throws IOException,
                                       AutomationException
Indicates if a contained action depends upon the specified feature class.

Product Availability

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

Specified by:
dependsUponFeatureClass in interface IActionCollection
Specified by:
dependsUponFeatureClass in interface IActionCollection2
Parameters:
piFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
Returns:
The bResult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disableActionsUsingLayer

public boolean disableActionsUsingLayer(ILayer piLayer)
                                 throws IOException,
                                        AutomationException
Disables all action using the specified layer for location trigger.

Product Availability

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

Specified by:
disableActionsUsingLayer in interface IActionCollection
Specified by:
disableActionsUsingLayer in interface IActionCollection2
Parameters:
piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The bResult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reenableActionsUsingLayer

public boolean reenableActionsUsingLayer(ILayer piLayer)
                                  throws IOException,
                                         AutomationException
Reenable all action using the specified layer for location trigger.

Product Availability

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

Specified by:
reenableActionsUsingLayer in interface IActionCollection
Specified by:
reenableActionsUsingLayer in interface IActionCollection2
Parameters:
piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The bResult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkLayers

public void checkLayers(boolean bRebuildGeometry)
                 throws IOException,
                        AutomationException
Checks for deleted Layers and disables affected actions.

Product Availability

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

Specified by:
checkLayers in interface IActionCollection
Specified by:
checkLayers in interface IActionCollection2
Parameters:
bRebuildGeometry - The bRebuildGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

actionNameExists

public boolean actionNameExists(String bstrName)
                         throws IOException,
                                AutomationException
Checks if an action within the collection exists with the specified name.

Product Availability

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

Specified by:
actionNameExists in interface IActionCollection2
Parameters:
bstrName - The bstrName (in)
Returns:
The bNameExists
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVersion

public double getVersion()
                  throws 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.

Product Availability

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

Specified by:
getVersion in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws 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.

Product Availability

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

Specified by:
getName in interface IAction
Returns:
The pbstrName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRulesDescription

public String getRulesDescription()
                           throws 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.

Product Availability

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

Specified by:
getRulesDescription in interface IAction
Returns:
The pbstrRulesDescription
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isContinueProcessing

public 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.

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.

Product Availability

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

Specified by:
isContinueProcessing in interface IAction
Returns:
The pbvarContinueProcessing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlias

public String getAlias()
                throws 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.

Product Availability

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

Specified by:
getAlias in interface IAction
Returns:
The pbstrAlias
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAlias

public void setAlias(String pbstrAlias)
              throws 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.

Product Availability

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

Specified by:
setAlias in interface IAction
Parameters:
pbstrAlias - The pbstrAlias (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws 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.

Product Availability

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

Specified by:
getLabel in interface IAction
Returns:
The pbstrLabel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String pbstrLabel)
              throws 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.

Product Availability

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

Specified by:
setLabel in interface IAction
Parameters:
pbstrLabel - The pbstrLabel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public String getType()
               throws 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.

Product Availability

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

Specified by:
getType in interface IAction
Returns:
The pbstrType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnabled

public 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. Requires Tracking Analyst Extension.

Specified by:
isEnabled in interface IAction
Returns:
The pbvarIsEnabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsEnabled

public 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. Requires Tracking Analyst Extension.

Specified by:
setIsEnabled in interface IAction
Parameters:
pbvarIsEnabled - The pbvarIsEnabled (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStopProcessing

public 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.

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.

Product Availability

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

Specified by:
setStopProcessing in interface IAction
Parameters:
pbvarStopProcessing - The pbvarStopProcessing (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

evaluate

public void evaluate(Object piObject,
                     Object[] pvarReturnedObjects)
              throws 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.

Product Availability

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

Specified by:
evaluate in interface IAction
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

public boolean isStopProcessing()
                         throws IOException,
                                AutomationException
Indicates if 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.

Product Availability

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

Specified by:
isStopProcessing in interface IAction
Returns:
The pbvarStopProcessing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEvaluationCount

public int getEvaluationCount()
                       throws 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.

Product Availability

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

Specified by:
getEvaluationCount in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStopProcessingCount

public int getStopProcessingCount()
                           throws 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.

Product Availability

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

Specified by:
getStopProcessingCount in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilteredCount

public int getFilteredCount()
                     throws 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.

Product Availability

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

Specified by:
getFilteredCount in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getModifiedCount

public int getModifiedCount()
                     throws 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.

Product Availability

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

Specified by:
getModifiedCount in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProcessedCount

public int getProcessedCount()
                      throws 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.

Product Availability

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

Specified by:
getProcessedCount in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearCounts

public void clearCounts()
                 throws IOException,
                        AutomationException
Clears all the internal counters for this action.

Description

This property clears all the internal counters for this action.

Product Availability

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

Specified by:
clearCounts in interface IAction
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActionCategory

public 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. Requires Tracking Analyst Extension.

Specified by:
getActionCategory in interface IAction
Returns:
A com.esri.arcgis.trackinganalyst.enumActionCategory constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActionCategory

public 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. Requires Tracking Analyst Extension.

Specified by:
setActionCategory in interface IAction
Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumActionCategory constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws IOException,
                   AutomationException
Notify a tracking action that lookup table values have changed.

Product Availability

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

Specified by:
update in interface IActionUpdate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetToDefaultState

public void resetToDefaultState()
                         throws IOException,
                                AutomationException
Reset the State information to default.

Product Availability

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

Specified by:
resetToDefaultState in interface IActionState
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException