com.esri.arcgis.trackinganalyst
Interface ILocationTriggerAdmin

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArrivingLocationTrigger, CrossingLocationTrigger, ILocationTriggerAdminProxy, ProximityLocationTrigger

public interface ILocationTriggerAdmin
extends Serializable

Provides access to properties and methods needed to configure location triggers for tracking actions.

Description

This interface is new at ArcGIS 9.3.

Remarks

Custom Location Triggers should implement this interface in addition to ILocationTrigger. This interface provides the methods to allow the trigger to be configured.

Product Availability

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

Method Summary

void	configure(int hParentWindowHandle, ISet piObjects) Open a configuration dialog for the location trigger properties.
IPropertySet	getProperties() PropertySet of all configurable items for this location trigger.
void	initializeState() Initializes the Location Trigger to its default state.
boolean	isHasConfigurationDialog() Indicates whether this location trigger has a Configuration Dialog or not.
boolean	isNeedsTestGeometry() Indicates whether this location trigger needs to have a test geometry.
boolean	isValidateProperties() Indicates whether this location trigger has been configured properly.
void	setProperties(IPropertySet ppiProperties) PropertySet of all configurable items for this location trigger.

Method Detail

getProperties

IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

PropertySet of all configurable items for this location trigger.

Remarks

The PropertySet should contain all of the configuration information for the Location Trigger. The supported property name-value pairs are defined by the coclass.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProperties

void setProperties(IPropertySet ppiProperties)
                   throws IOException,
                          AutomationException

PropertySet of all configurable items for this location trigger.

Product Availability

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

Parameters:

ppiProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasConfigurationDialog

boolean isHasConfigurationDialog()
                                 throws IOException,
                                        AutomationException

Indicates whether this location trigger has a Configuration Dialog or not.

Description

Use this property to determine if the location trigger has a dialog that can be used to generate the configuration properties. If a configuration dialog exists, it can be used in place of programmatically calling put_Properties.

Product Availability

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

Returns:

The pbvarHasConfigurationDialog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValidateProperties

boolean isValidateProperties()
                             throws IOException,
                                    AutomationException

Indicates whether this location trigger has been configured properly.

Description

ValidateProperties can be used after the configuration properties have been set, using either put_Properties or configure, to verify that the resulting location trigger is valid. If the result is returned as VARIANT_FALSE you will need to reconfigure the trigger before it will be evaluated.

Product Availability

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

Returns:

The pbvarValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

configure

void configure(int hParentWindowHandle,
               ISet piObjects)
               throws IOException,
                      AutomationException

Open a configuration dialog for the location trigger properties. At a minimum the ISet will contain one or more of the following objects, Action to be edited, Trigger Layer, Server Connection, and Polygon Source Name.

Product Availability

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

Parameters:

hParentWindowHandle - The hParentWindowHandle (A COM typedef) (in)

piObjects - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNeedsTestGeometry

boolean isNeedsTestGeometry()
                            throws IOException,
                                   AutomationException

Indicates whether this location trigger needs to have a test geometry.

Product Availability

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

Returns:

The pbvarValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initializeState

void initializeState()
                     throws IOException,
                            AutomationException

Initializes the Location Trigger to its default state.

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.