com.esri.arcgis.trackinganalyst
Interface IConditionalAction

All Superinterfaces:

Serializable

All Known Implementing Classes:

ActionBase, DataModificationAction, DataPartitionAction, DataSummaryAction, EmailAlertAction, FilterAction, HighlightSuppressionAction, IConditionalActionProxy, TagAction

public interface IConditionalAction
extends Serializable

Provides access to properties and methods needed to manage conditional actions.

Superseded By

IConditionalAction4

Description

This interface provides access to properties that manage conditional actions. Users can control location and attribute triggers, spatial reference used by the action, test geometry and trigger layer.

Remarks

The IConditionalAction interface has been superseded by IConditionalAction4. Please consider using the more recent version.

Product Availability

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

Method Summary

Object	getColumnList() The list of columns from the feature or the dataset definition.
String	getLocationTriggerName() Name of the custom location trigger for the action if one is being used.
int	getLocationTriggerType() Spatial relationship of an intrinsic location trigger.
String	getPolygonSource() Not Implemented - Use the PolygonSourceName property of IConditionalAction2.
String	getQueryString() SQL query for an attribute trigger.
String	getSpatialReference() String describing the Spatial Reference used by the Action.
IGeometry	getTestGeometry() Geometry used for location trigger test.
ILayer	getTriggerLayer() Layer containing location test polygons.
String	getTriggerLayerName() Name of layer containing location test polygons.
int	getTriggerType() Type of trigger used to execute an action: Always, Location, Attribute, or Attribute and Location.
boolean	isNegateLocationTrigger() Indicates whether or not to negate results of the location trigger.
void	setColumnList(Object pVal) The list of columns from the feature or the dataset definition.
void	setLocationTriggerName(String pVal) Name of the custom location trigger for the action if one is being used.
void	setLocationTriggerType(int pVal) Spatial relationship of an intrinsic location trigger.
void	setNegateLocationTrigger(boolean pVal) Indicates whether or not to negate results of the location trigger.
void	setPolygonSource(String pVal) Not Implemented - Use the PolygonSourceName property of IConditionalAction2.
void	setQueryString(String pVal) SQL query for an attribute trigger.
void	setSpatialReference(String pVal) String describing the Spatial Reference used by the Action.
void	setTestGeometry(IGeometry ppiTestGeometry) Geometry used for location trigger test.
void	setTriggerLayerByRef(ILayer pVal) Layer containing location test polygons.
void	setTriggerType(int pVal) Type of trigger used to execute an action: Always, Location, Attribute, or Attribute and Location.

Method Detail

getTriggerType

int getTriggerType()
                   throws IOException,
                          AutomationException

Type of trigger used to execute an action: Always, Location, Attribute, or Attribute and Location.

Product Availability

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

Returns:

A com.esri.arcgis.trackinganalyst.enumTriggerType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTriggerType

void setTriggerType(int pVal)
                    throws IOException,
                           AutomationException

Type of trigger used to execute an action: Always, Location, Attribute, or Attribute and Location.

Product Availability

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

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumTriggerType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTriggerType

int getLocationTriggerType()
                           throws IOException,
                                  AutomationException

Spatial relationship of an intrinsic location trigger.

Description

This property indicates the spatial relationship of an intrinsic location trigger. See esriSpatialRelEnum for detail.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationTriggerType

void setLocationTriggerType(int pVal)
                            throws IOException,
                                   AutomationException

Spatial relationship of an intrinsic location trigger.

Product Availability

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

Parameters:

pVal - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryString

String getQueryString()
                      throws IOException,
                             AutomationException

SQL query for an attribute trigger.

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.

setQueryString

void setQueryString(String pVal)
                    throws IOException,
                           AutomationException

SQL query for an attribute trigger.

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.

getTriggerLayer

ILayer getTriggerLayer()
                       throws IOException,
                              AutomationException

Layer containing location test polygons.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTriggerLayerByRef

void setTriggerLayerByRef(ILayer pVal)
                          throws IOException,
                                 AutomationException

Layer containing location test polygons.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNegateLocationTrigger

boolean isNegateLocationTrigger()
                                throws IOException,
                                       AutomationException

Indicates whether or not to negate results of the location trigger.

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.

setNegateLocationTrigger

void setNegateLocationTrigger(boolean pVal)
                              throws IOException,
                                     AutomationException

Indicates whether or not to negate results of the location trigger.

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.

getPolygonSource

String getPolygonSource()
                        throws IOException,
                               AutomationException

Not Implemented - Use the PolygonSourceName property of IConditionalAction2.

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.

setPolygonSource

void setPolygonSource(String pVal)
                      throws IOException,
                             AutomationException

Not Implemented - Use the PolygonSourceName property of IConditionalAction2.

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.

getColumnList

Object getColumnList()
                     throws IOException,
                            AutomationException

The list of columns from the feature or the dataset definition.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColumnList

void setColumnList(Object pVal)
                   throws IOException,
                          AutomationException

The list of columns from the feature or the dataset definition.

Product Availability

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

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTriggerLayerName

String getTriggerLayerName()
                           throws IOException,
                                  AutomationException

Name of layer containing location test polygons.

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.

setLocationTriggerName

void setLocationTriggerName(String pVal)
                            throws IOException,
                                   AutomationException

Name of the custom location trigger for the action if one is being used.

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.

getLocationTriggerName

String getLocationTriggerName()
                              throws IOException,
                                     AutomationException

Name of the custom location trigger for the action if one is being used.

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.

setTestGeometry

void setTestGeometry(IGeometry ppiTestGeometry)
                     throws IOException,
                            AutomationException

Geometry used for location trigger test.

Product Availability

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

Parameters:

ppiTestGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTestGeometry

IGeometry getTestGeometry()
                          throws IOException,
                                 AutomationException

Geometry used for location trigger test.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReference

void setSpatialReference(String pVal)
                         throws IOException,
                                AutomationException

String describing the Spatial Reference used by the Action.

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.

getSpatialReference

String getSpatialReference()
                           throws IOException,
                                  AutomationException

String describing the Spatial Reference used by the Action.

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.