com.esri.arcgis.trackinganalyst
Interface IActionCollection2

All Superinterfaces:

Serializable

All Known Implementing Classes:

ActionCollection

public interface IActionCollection2
extends Serializable

Provides access to the methods and properties needed to manage a collection of actions.

Description

This interface provides properties and methods that allow a collection of action objects, or COM objects that implement the IAction interface, to be managed in an ordered collection. The action processor uses this interface to iterate a set of action objects in order to process them from top to bottom.

Product Availability

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

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	checkLayers(boolean bRebuildGeometry) Checks for deleted Layers and disables affected actions.
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.
int	find(IAction piAction) Finds an action within the collection.
IAction	getAction(int nIndex) Retrieves the action at the specified index.
int	getActionCount() Total number of actions.
int	getCount() Number of objects in the collection.
int	getEnabledActionCount() Number of enabled actions.
int	getExclusionCategory() Action category to be excluded from processing.
int	getMaximumDepth() Maximum number of nested action levels to be processed.
int	getNextActionNumber() Gives next sequential number for assigning names to actions.
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	setExclusionCategory(int pVal) Action category to be excluded from processing.
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.

Method Detail

add

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.

Parameters:

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

nIndex - The nIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

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.

Parameters:

nIndex - The nIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

move

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.

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

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.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAction

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.

Parameters:

nIndex - The nIndex (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

Number of objects in the collection.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

find

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.

Parameters:

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

Returns:

The pnIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumDepth

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumDepth

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNextActionNumber

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNextActionNumber

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExclusionCategory

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.

Returns:

A com.esri.arcgis.carto.enumActionCategory constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExclusionCategory

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.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActionCount

int getActionCount()
                   throws IOException,
                          AutomationException

Total number of actions.

Description

This property retrieves the Total number of actions in the collection.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnabledActionCount

int getEnabledActionCount()
                          throws IOException,
                                 AutomationException

Number of enabled actions.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

dependsUponFeatureClass

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.

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

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.

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

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.

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

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.

Parameters:

bRebuildGeometry - The bRebuildGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

actionNameExists

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.

Parameters:

bstrName - The bstrName (in)

Returns:

The bNameExists

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.