com.esri.arcgis.trackinganalyst
Class ConditionalActionHelper

java.lang.Object
  com.esri.arcgis.trackinganalyst.ConditionalActionHelper

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IConditionalActionConfigure, IConditionalActionSetup, Serializable

public class ConditionalActionHelper
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IConditionalActionConfigure, IConditionalActionSetup

This class serves as a base tracking action configuration foundation object that can be used to build or aggregate new tracking action configuration dialogs.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ConditionalActionHelper()
Constructs a ConditionalActionHelper using ArcGIS Engine.

ConditionalActionHelper(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ConditionalActionHelper theConditionalActionHelper = (ConditionalActionHelper) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
int	getActionCategory() Get the Actions Category.
ILayer	getActionLayer() Get TODO.
IAction	getActionToEdit() Action for the control to edit.
static String	getClsid() getClsid.
IAction	getCurrentAction() Get The Current Action object that is being edited.
ILocationTrigger	getCurrentLocationTrigger() Get TODO.
String	getCurrentLocationTriggerName() Get TODO.
ILayer	getCurrentTriggerLayer() Get TODO.
ILocationTrigger	getLocationTrigger(int nIndex) Get TODO.
int	getLocationTriggerCount() Get TODO.
String	getLocationTriggerDescription(int nIndex) Get TODO.
String	getLocationTriggerName(int nIndex) Get TODO.
int	getLocationTriggerType() Get TODO.
IName	getPolygonSourceName() Get TODO.
String	getPolygonSourceNameText() Get TODO.
String	getQueryString() Get TODO.
IServerConnection	getServerConnection() Get the server interface if applicable.
int	getServerGeoType() Get TODO.
ILayer	getTriggerLayer(int nIndex) Get TODO.
int	getTriggerLayerCount() Get TODO.
String	getTriggerLayerName(int nIndex) Get TODO.
int	getTriggerType() Get the Actions Trigger Type.
int	hashCode() the hashcode for this object
boolean	isNegateLocationTrigger() Get whether or not to negate the location trigger test results.
boolean	isReadOnly() Indicates if the action properties are read-only.
void	setActionCategory(int pActionCategory) Get the Actions Category.
void	setActionLayerByRef(ILayer ippActionLayer) Get TODO.
void	setActionToEditByRef(IAction pVal) Action for the control to edit.
void	setCurrentLocationTriggerNameAndDesc(String bstrCustomLocationTriggerName, String bstrCustomLocationTriggerDesc) Get TODO.
void	setCurrentTriggerLayerByRef(ILayer ippTriggerLayer) Get TODO.
void	setLocationTriggerType(int pLocationTriggerType) Get TODO.
void	setNegateLocationTrigger(boolean pNegateLocationTrigger) Get whether or not to negate the location trigger test results.
void	setPolygonSourceNameByRef(IName ippPolygonSourceName) Get TODO.
void	setQueryString(String pbstrQueryString) Get TODO.
void	setReadOnly(boolean pbvalReadOnly) Indicates if the action properties are read-only.
void	setServerConnection(IServerConnection piServerConnection) Set the active server connection, if running in a tracking server environment or service environment in a client application.
void	setServerGeoType(int peServerGeoType) Get TODO.
void	setTriggerType(int pTriggerType) Get the Actions Trigger Type.
void	updateAction() Update the Action component with the values in the activeX component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ConditionalActionHelper

public ConditionalActionHelper()
                        throws IOException,
                               UnknownHostException

Constructs a ConditionalActionHelper using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ConditionalActionHelper

public ConditionalActionHelper(Object obj)
                        throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ConditionalActionHelper theConditionalActionHelper = (ConditionalActionHelper) obj;

Construct a ConditionalActionHelper using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ConditionalActionHelper.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getActionToEdit

public IAction getActionToEdit()
                        throws IOException,
                               AutomationException

Action for the control to edit.

Product Availability

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

Specified by:

getActionToEdit in interface IConditionalActionConfigure

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActionToEditByRef

public void setActionToEditByRef(IAction pVal)
                          throws IOException,
                                 AutomationException

Action for the control to edit.

Product Availability

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

Specified by:

setActionToEditByRef in interface IConditionalActionConfigure

Parameters:

pVal - A reference to a com.esri.arcgis.trackinganalyst.IAction (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReadOnly

public boolean isReadOnly()
                   throws IOException,
                          AutomationException

Indicates if the action properties are read-only.

Product Availability

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

Specified by:

isReadOnly in interface IConditionalActionConfigure

Returns:

The pbvalReadOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReadOnly

public void setReadOnly(boolean pbvalReadOnly)
                 throws IOException,
                        AutomationException

Indicates if the action properties are read-only.

Product Availability

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

Specified by:

setReadOnly in interface IConditionalActionConfigure

Parameters:

pbvalReadOnly - The pbvalReadOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateAction

public void updateAction()
                  throws IOException,
                         AutomationException

Update the Action component with the values in the activeX component.

Product Availability

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

Specified by:

updateAction in interface IConditionalActionConfigure

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerConnection

public void setServerConnection(IServerConnection piServerConnection)
                         throws IOException,
                                AutomationException

Set the active server connection, if running in a tracking server environment or service environment in a client application.

Product Availability

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

Specified by:

setServerConnection in interface IConditionalActionConfigure

Parameters:

piServerConnection - A reference to a com.esri.arcgis.trackinganalyst.IServerConnection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTriggerType

public void setTriggerType(int pTriggerType)
                    throws IOException,
                           AutomationException

Get the Actions Trigger Type.

Product Availability

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

Specified by:

setTriggerType in interface IConditionalActionSetup

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTriggerType

public int getTriggerType()
                   throws IOException,
                          AutomationException

Get the Actions Trigger Type.

Product Availability

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

Specified by:

getTriggerType in interface IConditionalActionSetup

Returns:

A com.esri.arcgis.trackinganalyst.enumTriggerType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationTriggerType

public void setLocationTriggerType(int pLocationTriggerType)
                            throws IOException,
                                   AutomationException

Get TODO.

Product Availability

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

Specified by:

setLocationTriggerType in interface IConditionalActionSetup

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTriggerType

public int getLocationTriggerType()
                           throws IOException,
                                  AutomationException

Get TODO.

Product Availability

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

Specified by:

getLocationTriggerType in interface IConditionalActionSetup

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActionCategory

public int getActionCategory()
                      throws IOException,
                             AutomationException

Get the Actions Category.

Product Availability

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

Specified by:

getActionCategory in interface IConditionalActionSetup

Returns:

A com.esri.arcgis.trackinganalyst.enumActionCategory constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActionCategory

public void setActionCategory(int pActionCategory)
                       throws IOException,
                              AutomationException

Get the Actions Category.

Product Availability

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

Specified by:

setActionCategory in interface IConditionalActionSetup

Parameters:

pActionCategory - A com.esri.arcgis.trackinganalyst.enumActionCategory constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerGeoType

public void setServerGeoType(int peServerGeoType)
                      throws IOException,
                             AutomationException

Get TODO.

Product Availability

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

Specified by:

setServerGeoType in interface IConditionalActionSetup

Parameters:

peServerGeoType - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerGeoType

public int getServerGeoType()
                     throws IOException,
                            AutomationException

Get TODO.

Product Availability

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

Specified by:

getServerGeoType in interface IConditionalActionSetup

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNegateLocationTrigger

public boolean isNegateLocationTrigger()
                                throws IOException,
                                       AutomationException

Get whether or not to negate the location trigger test results.

Product Availability

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

Specified by:

isNegateLocationTrigger in interface IConditionalActionSetup

Returns:

The pNegateLocationTrigger

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNegateLocationTrigger

public void setNegateLocationTrigger(boolean pNegateLocationTrigger)
                              throws IOException,
                                     AutomationException

Get whether or not to negate the location trigger test results.

Product Availability

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

Specified by:

setNegateLocationTrigger in interface IConditionalActionSetup

Parameters:

pNegateLocationTrigger - The pNegateLocationTrigger (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerConnection

public IServerConnection getServerConnection()
                                      throws IOException,
                                             AutomationException

Get the server interface if applicable.

Product Availability

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

Specified by:

getServerConnection in interface IConditionalActionSetup

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentLocationTrigger

public ILocationTrigger getCurrentLocationTrigger()
                                           throws IOException,
                                                  AutomationException

Get TODO.

Product Availability

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

Specified by:

getCurrentLocationTrigger in interface IConditionalActionSetup

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.

getCurrentLocationTriggerName

public String getCurrentLocationTriggerName()
                                     throws IOException,
                                            AutomationException

Get TODO.

Product Availability

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

Specified by:

getCurrentLocationTriggerName in interface IConditionalActionSetup

Returns:

The pbstrCustomLocationTriggerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentLocationTriggerNameAndDesc

public void setCurrentLocationTriggerNameAndDesc(String bstrCustomLocationTriggerName,
                                                 String bstrCustomLocationTriggerDesc)
                                          throws IOException,
                                                 AutomationException

Get TODO.

Product Availability

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

Specified by:

setCurrentLocationTriggerNameAndDesc in interface IConditionalActionSetup

Parameters:

bstrCustomLocationTriggerName - The bstrCustomLocationTriggerName (in)

bstrCustomLocationTriggerDesc - The bstrCustomLocationTriggerDesc (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActionLayer

public ILayer getActionLayer()
                      throws IOException,
                             AutomationException

Get TODO.

Product Availability

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

Specified by:

getActionLayer in interface IConditionalActionSetup

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.

setActionLayerByRef

public void setActionLayerByRef(ILayer ippActionLayer)
                         throws IOException,
                                AutomationException

Get TODO.

Product Availability

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

Specified by:

setActionLayerByRef in interface IConditionalActionSetup

Parameters:

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

getQueryString

public String getQueryString()
                      throws IOException,
                             AutomationException

Get TODO.

Product Availability

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

Specified by:

getQueryString in interface IConditionalActionSetup

Returns:

The pbstrQueryString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryString

public void setQueryString(String pbstrQueryString)
                    throws IOException,
                           AutomationException

Get TODO.

Product Availability

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

Specified by:

setQueryString in interface IConditionalActionSetup

Parameters:

pbstrQueryString - The pbstrQueryString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolygonSourceName

public IName getPolygonSourceName()
                           throws IOException,
                                  AutomationException

Get TODO.

Product Availability

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

Specified by:

getPolygonSourceName in interface IConditionalActionSetup

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPolygonSourceNameByRef

public void setPolygonSourceNameByRef(IName ippPolygonSourceName)
                               throws IOException,
                                      AutomationException

Get TODO.

Product Availability

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

Specified by:

setPolygonSourceNameByRef in interface IConditionalActionSetup

Parameters:

ippPolygonSourceName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentTriggerLayer

public ILayer getCurrentTriggerLayer()
                              throws IOException,
                                     AutomationException

Get TODO.

Product Availability

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

Specified by:

getCurrentTriggerLayer in interface IConditionalActionSetup

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.

setCurrentTriggerLayerByRef

public void setCurrentTriggerLayerByRef(ILayer ippTriggerLayer)
                                 throws IOException,
                                        AutomationException

Get TODO.

Product Availability

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

Specified by:

setCurrentTriggerLayerByRef in interface IConditionalActionSetup

Parameters:

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

getPolygonSourceNameText

public String getPolygonSourceNameText()
                                throws IOException,
                                       AutomationException

Get TODO.

Product Availability

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

Specified by:

getPolygonSourceNameText in interface IConditionalActionSetup

Returns:

The pbstrPolygonSourceNameText

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTriggerLayerCount

public int getTriggerLayerCount()
                         throws IOException,
                                AutomationException

Get TODO.

Product Availability

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

Specified by:

getTriggerLayerCount in interface IConditionalActionSetup

Returns:

The nCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTriggerLayer

public ILayer getTriggerLayer(int nIndex)
                       throws IOException,
                              AutomationException

Get TODO.

Product Availability

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

Specified by:

getTriggerLayer in interface IConditionalActionSetup

Parameters:

nIndex - The nIndex (in)

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.

getTriggerLayerName

public String getTriggerLayerName(int nIndex)
                           throws IOException,
                                  AutomationException

Get TODO.

Product Availability

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

Specified by:

getTriggerLayerName in interface IConditionalActionSetup

Parameters:

nIndex - The nIndex (in)

Returns:

The bstrTriggerLayerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTriggerCount

public int getLocationTriggerCount()
                            throws IOException,
                                   AutomationException

Get TODO.

Product Availability

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

Specified by:

getLocationTriggerCount in interface IConditionalActionSetup

Returns:

The nCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTrigger

public ILocationTrigger getLocationTrigger(int nIndex)
                                    throws IOException,
                                           AutomationException

Get TODO.

Product Availability

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

Specified by:

getLocationTrigger in interface IConditionalActionSetup

Parameters:

nIndex - The nIndex (in)

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.

getLocationTriggerName

public String getLocationTriggerName(int nIndex)
                              throws IOException,
                                     AutomationException

Get TODO.

Product Availability

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

Specified by:

getLocationTriggerName in interface IConditionalActionSetup

Parameters:

nIndex - The nIndex (in)

Returns:

The bstrLocationTriggerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTriggerDescription

public String getLocationTriggerDescription(int nIndex)
                                     throws IOException,
                                            AutomationException

Get TODO.

Product Availability

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

Specified by:

getLocationTriggerDescription in interface IConditionalActionSetup

Parameters:

nIndex - The nIndex (in)

Returns:

The bstrLocationTriggerDesc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentAction

public IAction getCurrentAction()
                         throws IOException,
                                AutomationException

Get The Current Action object that is being edited.

Product Availability

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

Specified by:

getCurrentAction in interface IConditionalActionSetup

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.