com.esri.arcgis.trackinganalyst
Class ActionCollection

java.lang.Object
  com.esri.arcgis.trackinganalyst.ActionCollection

All Implemented Interfaces:

IAction, IActionCollection, IActionCollection2, IActionUpdate, IClone, IPersist, IPersistStream, ISupportErrorInfo, java.io.Serializable

public class ActionCollection

extends java.lang.Object

implements IActionCollection, IActionCollection2, ISupportErrorInfo, IAction, IPersistStream, IClone, IActionUpdate

The Action Collection object is a container of actions.

Product Availability

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

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.

See Also:

Serialized Form

Constructor Summary

ActionCollection()
Constructs a ActionCollection using ArcGIS Engine.

ActionCollection(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

boolean	actionNameExists(java.lang.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(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	evaluate(java.lang.Object piObject, java.lang.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.
java.lang.String	getAlias() Allows user to specify or retrieve the alias name for this action.
IAction	getAsIAction() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IActionCollection	getAsIActionCollection() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IActionCollection2	getAsIActionCollection2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IActionUpdate	getAsIActionUpdate() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	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.
java.lang.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.
java.lang.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.
java.lang.String	getRulesDescription() Describes what the action will do.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
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() Supported Platforms
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 whether or not the processing engine should stop processing further actions in the action list after this action finishes processing.
void	load(IStream pstm) Supported Platforms
void	move(int nSourceIndex, int nDestinationIndex) Moves an action to a user-specified location in the collection.
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	save(IStream pstm, int fClearDirty) Supported Platforms
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	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(java.lang.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 whether or not 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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionCollection

public ActionCollection()
                 throws java.io.IOException,
                        java.net.UnknownHostException

Constructs a ActionCollection using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ActionCollection

public ActionCollection(java.lang.Object obj)
                 throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
ActionCollection theActionCollection = (ActionCollection) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIActionCollection

public IActionCollection getAsIActionCollection()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIActionCollection2

public IActionCollection2 getAsIActionCollection2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAction

public IAction getAsIAction()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIActionUpdate

public IActionUpdate getAsIActionUpdate()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

add

public void add(IAction piAction,
                int nIndex)
         throws java.io.IOException,
                AutomationException

Description copied from interface: IActionCollection

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.

Specified by:

add in interface IActionCollection

Parameters:

piAction - A reference to a com.esri.arcgis.trackinganalyst.IAction (in)

nIndex - The nIndex (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

remove

public void remove(int nIndex)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IActionCollection

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.

Specified by:

remove in interface IActionCollection

Parameters:

nIndex - The nIndex (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

move

public void move(int nSourceIndex,
                 int nDestinationIndex)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IActionCollection

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.

Specified by:

move in interface IActionCollection

Parameters:

nSourceIndex - The nSourceIndex (in)

nDestinationIndex - The nDestinationIndex (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

removeAll

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

Description copied from interface: IActionCollection

Removes all actions from the index.

Description

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

Specified by:

removeAll in interface IActionCollection

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getAction

public IAction getAction(int nIndex)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IActionCollection

Retrieves the action at the specified index.

Description

This property retrieves the action at the specified index. If the specified index is beyond the valid range a S_FALSE is returned and the Action Argument is returned as NULL. On success this method will addref the retrieved action.

Specified by:

getAction in interface IActionCollection

Parameters:

nIndex - The nIndex (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IAction

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

Description copied from interface: IActionCollection

Number of objects in the collection.

Description

This method returns the number of objects in the collection.

Specified by:

getCount in interface IActionCollection

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

find

public int find(IAction piAction)
         throws java.io.IOException,
                AutomationException

Description copied from interface: IActionCollection

Finds an action within the collection.

Description

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

Specified by:

find in interface IActionCollection

Parameters:

piAction - A reference to a com.esri.arcgis.trackinganalyst.IAction (in)

Returns:

The pnIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumDepth

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

Description copied from interface: IActionCollection

Maximum number of nested action levels to be processed.

Specified by:

getMaximumDepth in interface IActionCollection

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumDepth

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

Description copied from interface: IActionCollection

Maximum number of nested action levels to be processed.

Specified by:

setMaximumDepth in interface IActionCollection

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNextActionNumber

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

Description copied from interface: IActionCollection

Gives next sequential number for assigning names to actions.

Specified by:

getNextActionNumber in interface IActionCollection

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setNextActionNumber

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

Description copied from interface: IActionCollection

Gives next sequential number for assigning names to actions.

Specified by:

setNextActionNumber in interface IActionCollection

Parameters:

pVal - The pVal (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getExclusionCategory

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

Description copied from interface: IActionCollection

Action category to be excluded from processing.

Specified by:

getExclusionCategory in interface IActionCollection

Returns:

A com.esri.arcgis.trackinganalyst.enumActionCategory constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setExclusionCategory

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

Description copied from interface: IActionCollection

Action category to be excluded from processing.

Specified by:

setExclusionCategory in interface IActionCollection

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.

getActionCount

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

Description copied from interface: IActionCollection

Total number of actions.

Specified by:

getActionCount in interface IActionCollection

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getEnabledActionCount

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

Description copied from interface: IActionCollection

Number of enabled actions.

Specified by:

getEnabledActionCount in interface IActionCollection

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

dependsUponFeatureClass

public boolean dependsUponFeatureClass(IFeatureClass piFeatureClass)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IActionCollection

Indicates if a contained action depends upon the specified feature class.

Specified by:

dependsUponFeatureClass in interface IActionCollection

Parameters:

piFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Returns:

The bResult

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disableActionsUsingLayer

public boolean disableActionsUsingLayer(ILayer piLayer)
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IActionCollection

Disables all action using the specified layer for location trigger.

Specified by:

disableActionsUsingLayer in interface IActionCollection

Parameters:

piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

The bResult

Throws:

AutomationException - If the ArcObject component throws an exception.

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

reenableActionsUsingLayer

public boolean reenableActionsUsingLayer(ILayer piLayer)
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IActionCollection

Reenable all action using the specified layer for location trigger.

Specified by:

reenableActionsUsingLayer in interface IActionCollection

Parameters:

piLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

The bResult

Throws:

AutomationException - If the ArcObject component throws an exception.

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

checkLayers

public void checkLayers(boolean bRebuildGeometry)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IActionCollection

Checks for deleted Layers and disables affected actions.

Specified by:

checkLayers in interface IActionCollection

Parameters:

bRebuildGeometry - The bRebuildGeometry (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

actionNameExists

public boolean actionNameExists(java.lang.String bstrName)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IActionCollection2

Checks if an action within the collection exists with the specified name.

Specified by:

actionNameExists in interface IActionCollection2

Parameters:

bstrName - The bstrName (in)

Returns:

The bNameExists

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getVersion

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

Description copied from interface: IAction

Allows user to retrieve the version number for this action.

Description

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

Specified by:

getVersion in interface IAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getName

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

Description copied from interface: IAction

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.

Specified by:

getName in interface IAction

Returns:

The pbstrName

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getRulesDescription

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

Description copied from interface: IAction

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.

Specified by:

getRulesDescription in interface IAction

Returns:

The pbstrRulesDescription

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isContinueProcessing

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

Description copied from interface: IAction

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.

Specified by:

isContinueProcessing in interface IAction

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

Description copied from interface: IAction

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.

Specified by:

getAlias in interface IAction

Returns:

The pbstrAlias

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setAlias

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

Description copied from interface: IAction

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.

Specified by:

setAlias in interface IAction

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

Description copied from interface: IAction

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.

Specified by:

getLabel in interface IAction

Returns:

The pbstrLabel

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setLabel

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

Description copied from interface: IAction

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.

Specified by:

setLabel in interface IAction

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

Description copied from interface: IAction

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.

Specified by:

getType in interface IAction

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

Description copied from interface: IAction

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

Specified by:

isEnabled in interface IAction

Returns:

The pbvarIsEnabled

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setIsEnabled

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

Description copied from interface: IAction

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

Specified by:

setIsEnabled in interface IAction

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

Description copied from interface: IAction

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.

Specified by:

setStopProcessing in interface IAction

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

Description copied from interface: IAction

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.

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:

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

Description copied from interface: IAction

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.

Specified by:

isStopProcessing in interface IAction

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

Description copied from interface: IAction

Number of times this action has been evaluated.

Description

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

Specified by:

getEvaluationCount in interface IAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getStopProcessingCount

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

Description copied from interface: IAction

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.

Specified by:

getStopProcessingCount in interface IAction

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

Description copied from interface: IAction

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.

Specified by:

getFilteredCount in interface IAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getModifiedCount

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

Description copied from interface: IAction

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.

Specified by:

getModifiedCount in interface IAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getProcessedCount

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

Description copied from interface: IAction

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.

Specified by:

getProcessedCount in interface IAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

clearCounts

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

Description copied from interface: IAction

Clears all the internal counters for this action.

Description

This property clears all the internal counters for this action.

Specified by:

clearCounts in interface IAction

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getActionCategory

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

Description copied from interface: IAction

Indicates the type of action to be applied to data.

Specified by:

getActionCategory in interface IAction

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

Description copied from interface: IAction

Indicates the type of action to be applied to data.

Specified by:

setActionCategory in interface IAction

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.

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClone

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

AutomationException - If the ArcObject component throws an exception.

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

update

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

Description copied from interface: IActionUpdate

Notify a tracking action that lookup table values have changed.

Specified by:

update in interface IActionUpdate

Throws:

AutomationException - If the ArcObject component throws an exception.

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