com.esri.arcgis.trackinganalyst
Interface IConditionalActionSetup

All Superinterfaces:

Serializable

All Known Implementing Classes:

ConditionalActionHelper

public interface IConditionalActionSetup
extends Serializable

Provides access to properties and methods needed to gather Conditional Action Setup information.

Product Availability

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

Method Summary

int	getActionCategory() Get the Actions Category.
ILayer	getActionLayer() Get TODO.
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.
boolean	isNegateLocationTrigger() Get whether or not to negate the location trigger test results.
void	setActionCategory(int pActionCategory) Get the Actions Category.
void	setActionLayerByRef(ILayer ippActionLayer) Get TODO.
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	setServerGeoType(int peServerGeoType) Get TODO.
void	setTriggerType(int pTriggerType) Get the Actions Trigger Type.

Method Detail

setTriggerType

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.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTriggerType

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.

Returns:

A com.esri.arcgis.carto.enumTriggerType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationTriggerType

void setLocationTriggerType(int pLocationTriggerType)
                            throws IOException,
                                   AutomationException

Get TODO.

Product Availability

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

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

int getLocationTriggerType()
                           throws IOException,
                                  AutomationException

Get TODO.

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.

getActionCategory

int getActionCategory()
                      throws IOException,
                             AutomationException

Get the Actions Category.

Product Availability

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

Returns:

A com.esri.arcgis.carto.enumActionCategory constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActionCategory

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.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerGeoType

void setServerGeoType(int peServerGeoType)
                      throws IOException,
                             AutomationException

Get TODO.

Product Availability

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

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

int getServerGeoType()
                     throws IOException,
                            AutomationException

Get TODO.

Product Availability

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

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNegateLocationTrigger

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.

Returns:

The pNegateLocationTrigger

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNegateLocationTrigger

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.

Parameters:

pNegateLocationTrigger - The pNegateLocationTrigger (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerConnection

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.

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

ILocationTrigger getCurrentLocationTrigger()
                                           throws IOException,
                                                  AutomationException

Get TODO.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentLocationTriggerName

String getCurrentLocationTriggerName()
                                     throws IOException,
                                            AutomationException

Get TODO.

Product Availability

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

Returns:

The pbstrCustomLocationTriggerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentLocationTriggerNameAndDesc

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.

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

ILayer getActionLayer()
                      throws IOException,
                             AutomationException

Get TODO.

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.

setActionLayerByRef

void setActionLayerByRef(ILayer ippActionLayer)
                         throws IOException,
                                AutomationException

Get TODO.

Product Availability

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

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

String getQueryString()
                      throws IOException,
                             AutomationException

Get TODO.

Product Availability

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

Returns:

The pbstrQueryString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryString

void setQueryString(String pbstrQueryString)
                    throws IOException,
                           AutomationException

Get TODO.

Product Availability

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

Parameters:

pbstrQueryString - The pbstrQueryString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolygonSourceName

IName getPolygonSourceName()
                           throws IOException,
                                  AutomationException

Get TODO.

Product Availability

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

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

void setPolygonSourceNameByRef(IName ippPolygonSourceName)
                               throws IOException,
                                      AutomationException

Get TODO.

Product Availability

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

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

ILayer getCurrentTriggerLayer()
                              throws IOException,
                                     AutomationException

Get TODO.

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.

setCurrentTriggerLayerByRef

void setCurrentTriggerLayerByRef(ILayer ippTriggerLayer)
                                 throws IOException,
                                        AutomationException

Get TODO.

Product Availability

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

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

String getPolygonSourceNameText()
                                throws IOException,
                                       AutomationException

Get TODO.

Product Availability

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

Returns:

The pbstrPolygonSourceNameText

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTriggerLayerCount

int getTriggerLayerCount()
                         throws IOException,
                                AutomationException

Get TODO.

Product Availability

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

Returns:

The nCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTriggerLayer

ILayer getTriggerLayer(int nIndex)
                       throws IOException,
                              AutomationException

Get TODO.

Product Availability

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

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

String getTriggerLayerName(int nIndex)
                           throws IOException,
                                  AutomationException

Get TODO.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

Returns:

The bstrTriggerLayerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTriggerCount

int getLocationTriggerCount()
                            throws IOException,
                                   AutomationException

Get TODO.

Product Availability

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

Returns:

The nCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTrigger

ILocationTrigger getLocationTrigger(int nIndex)
                                    throws IOException,
                                           AutomationException

Get TODO.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTriggerName

String getLocationTriggerName(int nIndex)
                              throws IOException,
                                     AutomationException

Get TODO.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

Returns:

The bstrLocationTriggerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTriggerDescription

String getLocationTriggerDescription(int nIndex)
                                     throws IOException,
                                            AutomationException

Get TODO.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

Returns:

The bstrLocationTriggerDesc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentAction

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.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.