com.esri.arcgis.carto
Interface IActionCollection

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ActionCollection, IActionCollectionProxy

public interface IActionCollection
extends java.io.Serializable

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

Description: 'Provides access to the methods and properties needed to manage a collection of actions.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDcc018a6d_24fb_11d4_b34c_00104ba2abcc
static int	xxDummy Deprecated. Internal use only

Method Summary

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.

Field Detail

IIDcc018a6d_24fb_11d4_b34c_00104ba2abcc

static final int IIDcc018a6d_24fb_11d4_b34c_00104ba2abcc

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

add

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

Adds an action to the collection.

Parameters:

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

nIndex - The nIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

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

Removes an action from the collection.

Parameters:

nIndex - The nIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

move

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

Moves an action to a user-specified location in the collection.

Parameters:

nSourceIndex - The nSourceIndex (in)

nDestinationIndex - The nDestinationIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all actions from the index.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAction

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

Retrieves the action at the specified index.

Parameters:

nIndex - The nIndex (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

Number of objects in the collection.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

find

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

Finds an action within the collection.

Parameters:

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

Returns:

The pnIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumDepth

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

Maximum number of nested action levels to be processed.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumDepth

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

Maximum number of nested action levels to be processed.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNextActionNumber

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

Gives next sequential number for assigning names to actions.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNextActionNumber

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

Gives next sequential number for assigning names to actions.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExclusionCategory

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

Action category to be excluded from processing.

Returns:

A com.esri.arcgis.carto.enumActionCategory constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExclusionCategory

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

Action category to be excluded from processing.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActionCount

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

Total number of actions.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEnabledActionCount

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

Number of enabled actions.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

dependsUponFeatureClass

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

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

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

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

Disables all action using the specified layer for location trigger.

Parameters:

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

Returns:

The bResult

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reenableActionsUsingLayer

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

Reenable all action using the specified layer for location trigger.

Parameters:

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

Returns:

The bResult

Throws:

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

AutomationException - If the ArcObject component throws an exception.

checkLayers

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

Checks for deleted Layers and disables affected actions.

Parameters:

bRebuildGeometry - The bRebuildGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.