com.esri.arcgis.trackinganalyst
Class ILocationTriggerAdminProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.trackinganalyst.ILocationTriggerAdminProxy

All Implemented Interfaces:

ILocationTriggerAdmin, Externalizable, Serializable

public class ILocationTriggerAdminProxy
extends com.esri.arcgis.interop.Dispatch
implements ILocationTriggerAdmin, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ILocationTriggerAdminProxy()
	ILocationTriggerAdminProxy(Object obj)
protected	ILocationTriggerAdminProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
void	setProperties(IPropertySet ppiProperties) PropertySet of all configurable items for this location trigger.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ILocationTriggerAdminProxy

public ILocationTriggerAdminProxy()

ILocationTriggerAdminProxy

public ILocationTriggerAdminProxy(Object obj)
                           throws IOException

Throws:

IOException

ILocationTriggerAdminProxy

protected ILocationTriggerAdminProxy(Object obj,
                                     String iid)
                              throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getProperties

public 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.

Specified by:

getProperties in interface ILocationTriggerAdmin

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

public 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.

Specified by:

setProperties in interface ILocationTriggerAdmin

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

public 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.

Specified by:

isHasConfigurationDialog in interface ILocationTriggerAdmin

Returns:

The pbvarHasConfigurationDialog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValidateProperties

public 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.

Specified by:

isValidateProperties in interface ILocationTriggerAdmin

Returns:

The pbvarValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

configure

public 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.

Specified by:

configure in interface ILocationTriggerAdmin

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

public 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.

Specified by:

isNeedsTestGeometry in interface ILocationTriggerAdmin

Returns:

The pbvarValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initializeState

public 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.

Specified by:

initializeState in interface ILocationTriggerAdmin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.