com.esri.arcgis.trackinganalyst
Interface IConditionalAction4

All Superinterfaces:

IConditionalAction2, Serializable

All Known Implementing Classes:

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

public interface IConditionalAction4
extends IConditionalAction2, Serializable

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

Description

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

Remarks

This interface is new at ArcGIS 9.3. It supersedes IConditionalAction2.

Product Availability

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

Method Summary

ILocationTrigger	getLocationTrigger() Custom location trigger for the action if one is being used.
boolean	isFavorQuery() Indicates if the Attribute Query should be performed first and then the location test.
void	setFavorQuery(boolean pVal) Indicates if the Attribute Query should be performed first and then the location test.
void	setLocationTriggerByRef(ILocationTrigger ppLocationTrigger) Custom location trigger for the action if one is being used.

Methods inherited from interface com.esri.arcgis.trackinganalyst.IConditionalAction2

getColumnList, getLocationTriggerName, getLocationTriggerType, getPolygonSourceName, getQueryString, getSpatialReference, getTestGeometry, getTriggerLayer, getTriggerLayerName, getTriggerType, isNegateLocationTrigger, setColumnList, setLocationTriggerName, setLocationTriggerType, setNegateLocationTrigger, setPolygonSourceNameByRef, setQueryString, setSpatialReference, setTestGeometry, setTriggerLayerByRef, setTriggerType

Method Detail

isFavorQuery

boolean isFavorQuery()
                     throws IOException,
                            AutomationException

Indicates if the Attribute Query should be performed first and then the location test.

Description

Returns and sets whether the attribute query should be performed before the spatial query when evaluating the action.

Remarks

A judicious choice may significantly improve the performance of the query. The rule of thumb for selecting which query to perform first is the one that is likely to exclude the most values. This way the number of times the second query is called is minimized.

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.

setFavorQuery

void setFavorQuery(boolean pVal)
                   throws IOException,
                          AutomationException

Indicates if the Attribute Query should be performed first and then the location test.

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.

setLocationTriggerByRef

void setLocationTriggerByRef(ILocationTrigger ppLocationTrigger)
                             throws IOException,
                                    AutomationException

Custom location trigger for the action if one is being used.

Description

Returns or sets the custom location trigger to use with the action. Custom location triggers allow for spatial queries to be performed beyond the default intersects or not intersects. For example, a custom location trigger could evaluate when an event crosses a boundary.

Product Availability

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

Parameters:

ppLocationTrigger - A reference to a com.esri.arcgis.trackinganalyst.ILocationTrigger (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTrigger

ILocationTrigger getLocationTrigger()
                                    throws IOException,
                                           AutomationException

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:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.