com.esri.arcgis.trackinganalyst
Class ActionBase

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.ActionBase
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IClone, IAction, IActionEdit, IActionHelper, IActionSetup, IActionState, IActionUpdate, IConditionalAction, IConditionalAction2, IConditionalAction4, ILayerAction, IServAction, Serializable

public class ActionBase
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAction, IActionEdit, ILayerAction, IServAction, IConditionalAction, IConditionalAction2, IConditionalAction4, IClone, IActionUpdate, IActionHelper, IActionSetup, IActionState

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

Description

This class serves as a base tracking action foundation that can be used to build or aggregate new tracking actions. This object provides the fundamental characteristics of an action such a attribute and location filtering. The processing of the feature or data message is to be implemented by the host object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ActionBase()
          Constructs a ActionBase using ArcGIS Engine.
ActionBase(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ActionBase theActionBase = (ActionBase) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void clearCounts()
          Clears all the internal counters for this action.
 void defaultAction()
          Sets the action to its default state and resets existing edits.
 void edit(int hParentWindowHandle, ISet piObjectSet)
          Invokes Edit dialog.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void evaluate(Object piObject, Object[] pvarReturnedObjects)
          Takes an input object and evaluates the object based on predefined criteria.
 int getActionCategory()
          Indicates the type of action to be applied to data.
 String getAlias()
          Allows user to specify or retrieve the alias name for this action.
static String getClsid()
          getClsid.
 Object getColumnList()
          The list of columns from the feature or the dataset definition.
 String getDatasetDefinitionID()
          Value of the DatasetDefinitionID property.
 String getDatasetDefinitionName()
          Value of the DatasetDefinitionName property.
 int getEvaluationCount()
          Number of times this action has been evaluated.
 int getEventIdColumnNumber()
          Number of the column containing EventID information.
 int getFilteredCount()
          Number of times this action has returned S_ACTIONPROCESSOR_MSG_FILTERED.
 int getGeometryColumnNumber()
          Value of the GeometryColumnNumber property.
 int getGeometryColumnType()
          Type of geomety object contained in the geometry column.
 int getHelpContextID(int lControlID)
          The help context ID for the specified control on the page.
 String getHelpFile()
          The help file name for the page.
 String getLabel()
          Allows user to specify or retreive tha label name for this action.
 ILayer getLayer()
          Tracking layer upon which the action is performed.
 ILocationTrigger getLocationTrigger()
          Custom location trigger for the action if one is being used.
 String getLocationTriggerName()
          Name of the custom location trigger for the action if one is being used.
 int getLocationTriggerType()
          Spatial relationship of an intrinsic location trigger.
 int getModifiedCount()
          Number of times this action has returned S_ACTIONPROCESSOR_MSG_MODIFIED.
 String getName()
          Developer-given name of the object.
 String getPolygonSource()
          Not Implemented - Use the PolygonSourceName property of IConditionalAction2.
 IName getPolygonSourceName()
          Name of a feature class containing polygons to test location trigger actions.
 int getPreviewImage()
          Preview bitmap for the renderer that appears on the page.
 int getProcessedCount()
          Number of times this action has returned S_ACTIONPROCESSOR_MSG_PROCESSED.
 String getQueryString()
          SQL query for an attribute trigger.
 String getRulesDescription()
          Describes what the action will do.
 String getSpatialReference()
          String describing the Spatial Reference used by the Action.
 int getStopProcessingCount()
          Number of times this action has returned S_ACTIONPROCESSOR_MSG_STOPPROCESSING.
 IGeometry getTestGeometry()
          Geometry used for location trigger test.
 int getTrackIdColumnNumber()
          Value of the TrackIdColumnNumber property.
 ILayer getTriggerLayer()
          Layer containing location test polygons.
 String getTriggerLayerName()
          Name of layer containing location test polygons.
 int getTriggerType()
          Type of trigger used to execute an action: Always, Location, Attribute, or Attribute and Location.
 String getType()
          Allows user to obtain a string describing the type of action object.
 double getVersion()
          Allows user to retrieve the version number for this action.
 int hashCode()
          the hashcode for this object
 void initialize(String bstrDeveloperName, String bstrTypeDescription, double dVersion)
          Initialize the Base or Child Action.
 boolean isContinueProcessing()
          Indicates whether or not the processing engine should stop processing further actions in the action list after this action finishes processing.
 boolean isEnabled()
          Indicates whether or not an action in the action list is enabled for processing.
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isFavorQuery()
          Indicates if the Attribute Query should be performed first and then the location test.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isNegateLocationTrigger()
          Indicates whether or not to negate results of the location trigger.
 boolean isStopProcessing()
          Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.
 void resetToDefaultState()
          Reset the State information to default.
 void setActionCategory(int pVal)
          Indicates the type of action to be applied to data.
 void setAlias(String pbstrAlias)
          Allows user to specify or retrieve the alias name for this action.
 void setColumnList(Object pVal)
          The list of columns from the feature or the dataset definition.
 void setDatasetDefinitionID(String bstrDatasetDefID)
          Value of the DatasetDefinitionID property.
 void setDatasetDefinitionName(String bstrDatasetDefName)
          Value of the DatasetDefinitionName property.
 void setEventIdColumnNumber(int iVal)
          Number of the column containing EventID information.
 void setFavorQuery(boolean pVal)
          Indicates if the Attribute Query should be performed first and then the location test.
 void setFromDataDefinition(IDatasetDef piDataDef)
          Set up the action based on a data definition.
 void setFromLayer(IFeatureLayer piLayer)
          Set up the action based on a feature layer.
 void setGeometryColumnNumber(int iVal)
          Value of the GeometryColumnNumber property.
 void setGeometryColumnType(int iVal)
          Type of geomety object contained in the geometry column.
 void setIsEnabled(boolean pbvarIsEnabled)
          Indicates whether or not an action in the action list is enabled for processing.
 void setLabel(String pbstrLabel)
          Allows user to specify or retreive tha label name for this action.
 void setLayerByRef(ILayer pVal)
          Tracking layer upon which the action is performed.
 void setLocationTriggerByRef(ILocationTrigger ppLocationTrigger)
          Custom location trigger for the action if one is being used.
 void setLocationTriggerName(String pVal)
          Name of the custom location trigger for the action if one is being used.
 void setLocationTriggerType(int pVal)
          Spatial relationship of an intrinsic location trigger.
 void setNegateLocationTrigger(boolean pVal)
          Indicates whether or not to negate results of the location trigger.
 void setPolygonSource(String pVal)
          Not Implemented - Use the PolygonSourceName property of IConditionalAction2.
 void setPolygonSourceNameByRef(IName ppiSourceName)
          Name of a feature class containing polygons to test location trigger actions.
 void setQueryString(String pVal)
          SQL query for an attribute trigger.
 void setReadOnly(boolean rhs1)
          Indicates whether the action is specified as read-only.
 void setSpatialReference(String pVal)
          String describing the Spatial Reference used by the Action.
 void setStopProcessing(boolean pbvarStopProcessing)
          Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.
 void setTestGeometry(IGeometry ppiTestGeometry)
          Geometry used for location trigger test.
 void setTrackIdColumnNumber(int iVal)
          Value of the TrackIdColumnNumber property.
 void setTriggerLayerByRef(ILayer pVal)
          Layer containing location test polygons.
 void setTriggerType(int pVal)
          Type of trigger used to execute an action: Always, Location, Attribute, or Attribute and Location.
 void update()
          Notify a tracking action that lookup table values have changed.
 
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

ActionBase

public ActionBase()
           throws IOException,
                  UnknownHostException
Constructs a ActionBase using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ActionBase

public ActionBase(Object obj)
           throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ActionBase theActionBase = (ActionBase) obj;

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

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

getVersion

public double getVersion()
                  throws IOException,
                         AutomationException
Allows user to retrieve the version number for this action.

Description

This property allows the user to retrieve the version number for this action.

Product Availability

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

Specified by:
getVersion in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
Developer-given name of the object.

Description

The name property is a developer given name of the object. This property cannot be changed and should be unique, such as the company ID or some other naming convention.

Product Availability

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

Specified by:
getName in interface IAction
Returns:
The pbstrName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRulesDescription

public String getRulesDescription()
                           throws IOException,
                                  AutomationException
Describes what the action will do.

Description

This property describes what the action will do. This string should contain details about the configuration. This property is similar to the Microsoft Outlook rules "Rules Description" text.

Product Availability

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

Specified by:
getRulesDescription in interface IAction
Returns:
The pbstrRulesDescription
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isContinueProcessing

public boolean isContinueProcessing()
                             throws IOException,
                                    AutomationException
Indicates whether or not the processing engine should stop processing further actions in the action list after this action finishes processing.

Description

This property controls whether or not the processing engine should stop processing further actions in the action list after this action processes. The internal object must control the state of this property and must allow or return VARIANT_TRUE if this action did not successfully process the current action. The action processor must call Evaluate with a data object before this property is valid.

If the object successfully processed the data and internally it has been told to stop processing further actions, then the return value should be VARIANT_FALSE signifying to the action processor to stop processing actions.

Note: This property is not a copy of the property put_StopProcessing. The StopProcessing or write version simply enables whether or not this property is processed or returns a VARIANT_FALSE. If the StopProcessing property is false then this property is always TRUE. Otherwise the last Evaluate call determines the state.

Product Availability

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

Specified by:
isContinueProcessing in interface IAction
Returns:
The pbvarContinueProcessing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlias

public String getAlias()
                throws IOException,
                       AutomationException
Allows user to specify or retrieve the alias name for this action.

Description

This property allows the user to specify or retrieve the alias name for this action.

Product Availability

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

Specified by:
getAlias in interface IAction
Returns:
The pbstrAlias
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAlias

public void setAlias(String pbstrAlias)
              throws IOException,
                     AutomationException
Allows user to specify or retrieve the alias name for this action.

Description

This property allows the user to specify or retrieve the alias name for this action.

Product Availability

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

Specified by:
setAlias in interface IAction
Parameters:
pbstrAlias - The pbstrAlias (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException
Allows user to specify or retreive tha label name for this action.

Description

This property allows the user to specify or retrieve the label name for this action.

Product Availability

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

Specified by:
getLabel in interface IAction
Returns:
The pbstrLabel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String pbstrLabel)
              throws IOException,
                     AutomationException
Allows user to specify or retreive tha label name for this action.

Description

This property allows the user to specify or retrieve the label name for this action.

Product Availability

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

Specified by:
setLabel in interface IAction
Parameters:
pbstrLabel - The pbstrLabel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public String getType()
               throws IOException,
                      AutomationException
Allows user to obtain a string describing the type of action object.

Description

The type property allows a user to obtain a string describing the type of action object. This is generally a one word description.

Product Availability

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

Specified by:
getType in interface IAction
Returns:
The pbstrType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException
Indicates whether or not an action in the action list is enabled for processing.

Product Availability

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

Specified by:
isEnabled in interface IAction
Returns:
The pbvarIsEnabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsEnabled

public void setIsEnabled(boolean pbvarIsEnabled)
                  throws IOException,
                         AutomationException
Indicates whether or not an action in the action list is enabled for processing.

Product Availability

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

Specified by:
setIsEnabled in interface IAction
Parameters:
pbvarIsEnabled - The pbvarIsEnabled (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStopProcessing

public void setStopProcessing(boolean pbvarStopProcessing)
                       throws IOException,
                              AutomationException
Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.

Description

This property controls whether or not the processing engine should stop processing further actions in the action list after this action processes. This enables the ContinueProcessing property to return a VARIANT_FALSE if no further processing should take place.

Product Availability

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

Specified by:
setStopProcessing in interface IAction
Parameters:
pbvarStopProcessing - The pbvarStopProcessing (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

evaluate

public void evaluate(Object piObject,
                     Object[] pvarReturnedObjects)
              throws IOException,
                     AutomationException
Takes an input object and evaluates the object based on predefined criteria.

Description

This method provides the entry point for the action processor to evaluate the data that is undergoing processing. This method takes a variant that is an object that implement either a IDatamessage or a IFeature interface.

Product Availability

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

Specified by:
evaluate in interface IAction
Parameters:
piObject - A reference to another Object (IUnknown) (in)
pvarReturnedObjects - A Variant (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isStopProcessing

public boolean isStopProcessing()
                         throws IOException,
                                AutomationException
Indicates if the processing engine should stop processing further actions in the action list after this action finishes processing.

Description

This property controls whether or not the processing engine should stop processing further actions in the action list after this action processes. This enables the ContinueProcessing property to return a VARIANT_FALSE if no furtherprocessing should take place.

Product Availability

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

Specified by:
isStopProcessing in interface IAction
Returns:
The pbvarStopProcessing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEvaluationCount

public int getEvaluationCount()
                       throws IOException,
                              AutomationException
Number of times this action has been evaluated.

Description

This property is a count of the number of times this action has been evaluated.

Product Availability

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

Specified by:
getEvaluationCount in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStopProcessingCount

public int getStopProcessingCount()
                           throws IOException,
                                  AutomationException
Number of times this action has returned S_ACTIONPROCESSOR_MSG_STOPPROCESSING.

Description

This property counts the number of times this action has returned S_ACTIONPROCESSOR_MSG_STOPPROCESSING.

Product Availability

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

Specified by:
getStopProcessingCount in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilteredCount

public int getFilteredCount()
                     throws IOException,
                            AutomationException
Number of times this action has returned S_ACTIONPROCESSOR_MSG_FILTERED.

Description

This property is a count of the number of times this action has returned S_ACTIONPROCESSOR_MSG_FILTERED.

Product Availability

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

Specified by:
getFilteredCount in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getModifiedCount

public int getModifiedCount()
                     throws IOException,
                            AutomationException
Number of times this action has returned S_ACTIONPROCESSOR_MSG_MODIFIED.

Description

This property is a count of the number of times this action has returned S_ACTIONPROCESSOR_MSG_MODIFIED.

Product Availability

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

Specified by:
getModifiedCount in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProcessedCount

public int getProcessedCount()
                      throws IOException,
                             AutomationException
Number of times this action has returned S_ACTIONPROCESSOR_MSG_PROCESSED.

Description

This property is a count of the number of times this action has returned S_ACTIONPROCESSOR_MSG_PROCESSED.

Product Availability

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

Specified by:
getProcessedCount in interface IAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearCounts

public void clearCounts()
                 throws IOException,
                        AutomationException
Clears all the internal counters for this action.

Description

This property clears all the internal counters for this action.

Product Availability

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

Specified by:
clearCounts in interface IAction
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActionCategory

public int getActionCategory()
                      throws IOException,
                             AutomationException
Indicates the type of action to be applied to data.

Product Availability

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

Specified by:
getActionCategory in interface IAction
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 pVal)
                       throws IOException,
                              AutomationException
Indicates the type of action to be applied to data.

Product Availability

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

Specified by:
setActionCategory in interface IAction
Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumActionCategory constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

defaultAction

public void defaultAction()
                   throws IOException,
                          AutomationException
Sets the action to its default state and resets existing edits.

Description

This method sets the action to its default state and clears or resets any existing edits.

Product Availability

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

Specified by:
defaultAction in interface IActionEdit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

edit

public void edit(int hParentWindowHandle,
                 ISet piObjectSet)
          throws IOException,
                 AutomationException
Invokes Edit dialog.

Description

This method invokes the editing dialog. The developer must ensure that the dialog is a modal dialog. The parent window handle is provided in order for the proper modal association to be set up.

Product Availability

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

Specified by:
edit in interface IActionEdit
Parameters:
hParentWindowHandle - The hParentWindowHandle (in)
piObjectSet - 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.

getPreviewImage

public int getPreviewImage()
                    throws IOException,
                           AutomationException
Preview bitmap for the renderer that appears on the page.

Description

This property allows you to preview a bitmap for the renderer that appears on the page.

Product Availability

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

Specified by:
getPreviewImage in interface IActionEdit
Returns:
The phBitmap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpFile

public String getHelpFile()
                   throws IOException,
                          AutomationException
The help file name for the page.

Description

This property controls the help file name for the page.

Product Availability

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

Specified by:
getHelpFile in interface IActionEdit
Returns:
The pbstrHelpFile
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpContextID

public int getHelpContextID(int lControlID)
                     throws IOException,
                            AutomationException
The help context ID for the specified control on the page.

Product Availability

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

Specified by:
getHelpContextID in interface IActionEdit
Parameters:
lControlID - The lControlID (in)
Returns:
The plHelpID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReadOnly

public void setReadOnly(boolean rhs1)
                 throws IOException,
                        AutomationException
Indicates whether the action is specified as read-only.

Product Availability

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

Specified by:
setReadOnly in interface IActionEdit
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer()
                throws IOException,
                       AutomationException
Tracking layer upon which the action is performed.

Product Availability

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

Specified by:
getLayer in interface ILayerAction
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.

setLayerByRef

public void setLayerByRef(ILayer pVal)
                   throws IOException,
                          AutomationException
Tracking layer upon which the action is performed.

Product Availability

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

Specified by:
setLayerByRef in interface ILayerAction
Parameters:
pVal - 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.

getEventIdColumnNumber

public int getEventIdColumnNumber()
                           throws IOException,
                                  AutomationException
Number of the column containing EventID information.

Product Availability

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

Specified by:
getEventIdColumnNumber in interface ILayerAction
Returns:
The iVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEventIdColumnNumber

public void setEventIdColumnNumber(int iVal)
                            throws IOException,
                                   AutomationException
Number of the column containing EventID information.

Product Availability

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

Specified by:
setEventIdColumnNumber in interface ILayerAction
Parameters:
iVal - The iVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDatasetDefinitionName

public String getDatasetDefinitionName()
                                throws IOException,
                                       AutomationException
Value of the DatasetDefinitionName property.

Description

Returns the value of the DatasetDefinitionName property.

Product Availability

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

Specified by:
getDatasetDefinitionName in interface IServAction
Returns:
The bstrDatasetDefName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDatasetDefinitionName

public void setDatasetDefinitionName(String bstrDatasetDefName)
                              throws IOException,
                                     AutomationException
Value of the DatasetDefinitionName property.

Description

Sets the value of the DatasetDefinitionName property.

Product Availability

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

Specified by:
setDatasetDefinitionName in interface IServAction
Parameters:
bstrDatasetDefName - The bstrDatasetDefName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDatasetDefinitionID

public String getDatasetDefinitionID()
                              throws IOException,
                                     AutomationException
Value of the DatasetDefinitionID property.

Description

Returns the value of the DatasetDefinitionID property.

Product Availability

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

Specified by:
getDatasetDefinitionID in interface IServAction
Returns:
The bstrDatasetDefID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDatasetDefinitionID

public void setDatasetDefinitionID(String bstrDatasetDefID)
                            throws IOException,
                                   AutomationException
Value of the DatasetDefinitionID property.

Description

Sets the value of the DatasetDefinitionID property.

Product Availability

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

Specified by:
setDatasetDefinitionID in interface IServAction
Parameters:
bstrDatasetDefID - The bstrDatasetDefID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometryColumnNumber

public int getGeometryColumnNumber()
                            throws IOException,
                                   AutomationException
Value of the GeometryColumnNumber property.

Description

Returns the value of the GeometryColumnNumber property.

Product Availability

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

Specified by:
getGeometryColumnNumber in interface IServAction
Returns:
The iVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeometryColumnNumber

public void setGeometryColumnNumber(int iVal)
                             throws IOException,
                                    AutomationException
Value of the GeometryColumnNumber property.

Description

Sets the value of the GeometryColumnNumber property.

Product Availability

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

Specified by:
setGeometryColumnNumber in interface IServAction
Parameters:
iVal - The iVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrackIdColumnNumber

public int getTrackIdColumnNumber()
                           throws IOException,
                                  AutomationException
Value of the TrackIdColumnNumber property.

Product Availability

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

Specified by:
getTrackIdColumnNumber in interface IServAction
Returns:
The iVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrackIdColumnNumber

public void setTrackIdColumnNumber(int iVal)
                            throws IOException,
                                   AutomationException
Value of the TrackIdColumnNumber property.

Product Availability

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

Specified by:
setTrackIdColumnNumber in interface IServAction
Parameters:
iVal - The iVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometryColumnType

public int getGeometryColumnType()
                          throws IOException,
                                 AutomationException
Type of geomety object contained in the geometry column.

Product Availability

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

Specified by:
getGeometryColumnType in interface IServAction
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeometryColumnType

public void setGeometryColumnType(int iVal)
                           throws IOException,
                                  AutomationException
Type of geomety object contained in the geometry column.

Product Availability

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

Specified by:
setGeometryColumnType in interface IServAction
Parameters:
iVal - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTriggerType

public int getTriggerType()
                   throws IOException,
                          AutomationException
Type of trigger used to execute an action: Always, Location, Attribute, or Attribute and Location.

Product Availability

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

Specified by:
getTriggerType in interface IConditionalAction
Specified by:
getTriggerType in interface IConditionalAction2
Returns:
A com.esri.arcgis.trackinganalyst.enumTriggerType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTriggerType

public void setTriggerType(int pVal)
                    throws IOException,
                           AutomationException
Type of trigger used to execute an action: Always, Location, Attribute, or Attribute and Location.

Product Availability

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

Specified by:
setTriggerType in interface IConditionalAction
Specified by:
setTriggerType in interface IConditionalAction2
Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumTriggerType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocationTriggerType

public int getLocationTriggerType()
                           throws IOException,
                                  AutomationException
Spatial relationship of an intrinsic location trigger.

Product Availability

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

Specified by:
getLocationTriggerType in interface IConditionalAction
Specified by:
getLocationTriggerType in interface IConditionalAction2
Returns:
A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocationTriggerType

public void setLocationTriggerType(int pVal)
                            throws IOException,
                                   AutomationException
Spatial relationship of an intrinsic location trigger.

Product Availability

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

Specified by:
setLocationTriggerType in interface IConditionalAction
Specified by:
setLocationTriggerType in interface IConditionalAction2
Parameters:
pVal - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getQueryString

public String getQueryString()
                      throws IOException,
                             AutomationException
SQL query for an attribute trigger.

Product Availability

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

Specified by:
getQueryString in interface IConditionalAction
Specified by:
getQueryString in interface IConditionalAction2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setQueryString

public void setQueryString(String pVal)
                    throws IOException,
                           AutomationException
SQL query for an attribute trigger.

Product Availability

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

Specified by:
setQueryString in interface IConditionalAction
Specified by:
setQueryString in interface IConditionalAction2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTriggerLayer

public ILayer getTriggerLayer()
                       throws IOException,
                              AutomationException
Layer containing location test polygons.

Product Availability

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

Specified by:
getTriggerLayer in interface IConditionalAction
Specified by:
getTriggerLayer in interface IConditionalAction2
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.

setTriggerLayerByRef

public void setTriggerLayerByRef(ILayer pVal)
                          throws IOException,
                                 AutomationException
Layer containing location test polygons.

Product Availability

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

Specified by:
setTriggerLayerByRef in interface IConditionalAction
Specified by:
setTriggerLayerByRef in interface IConditionalAction2
Parameters:
pVal - 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.

isNegateLocationTrigger

public boolean isNegateLocationTrigger()
                                throws IOException,
                                       AutomationException
Indicates whether or not to negate results of the location trigger.

Product Availability

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

Specified by:
isNegateLocationTrigger in interface IConditionalAction
Specified by:
isNegateLocationTrigger in interface IConditionalAction2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNegateLocationTrigger

public void setNegateLocationTrigger(boolean pVal)
                              throws IOException,
                                     AutomationException
Indicates whether or not to negate results of the location trigger.

Product Availability

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

Specified by:
setNegateLocationTrigger in interface IConditionalAction
Specified by:
setNegateLocationTrigger in interface IConditionalAction2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonSource

public String getPolygonSource()
                        throws IOException,
                               AutomationException
Not Implemented - Use the PolygonSourceName property of IConditionalAction2.

Product Availability

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

Specified by:
getPolygonSource in interface IConditionalAction
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPolygonSource

public void setPolygonSource(String pVal)
                      throws IOException,
                             AutomationException
Not Implemented - Use the PolygonSourceName property of IConditionalAction2.

Product Availability

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

Specified by:
setPolygonSource in interface IConditionalAction
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColumnList

public Object getColumnList()
                     throws IOException,
                            AutomationException
The list of columns from the feature or the dataset definition.

Product Availability

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

Specified by:
getColumnList in interface IConditionalAction
Specified by:
getColumnList in interface IConditionalAction2
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColumnList

public void setColumnList(Object pVal)
                   throws IOException,
                          AutomationException
The list of columns from the feature or the dataset definition.

Product Availability

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

Specified by:
setColumnList in interface IConditionalAction
Specified by:
setColumnList in interface IConditionalAction2
Parameters:
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTriggerLayerName

public String getTriggerLayerName()
                           throws IOException,
                                  AutomationException
Name of layer containing location test polygons.

Product Availability

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

Specified by:
getTriggerLayerName in interface IConditionalAction
Specified by:
getTriggerLayerName in interface IConditionalAction2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocationTriggerName

public void setLocationTriggerName(String pVal)
                            throws IOException,
                                   AutomationException
Name of the 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.

Specified by:
setLocationTriggerName in interface IConditionalAction
Specified by:
setLocationTriggerName in interface IConditionalAction2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocationTriggerName

public String getLocationTriggerName()
                              throws IOException,
                                     AutomationException
Name of the 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.

Specified by:
getLocationTriggerName in interface IConditionalAction
Specified by:
getLocationTriggerName in interface IConditionalAction2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTestGeometry

public void setTestGeometry(IGeometry ppiTestGeometry)
                     throws IOException,
                            AutomationException
Geometry used for location trigger test.

Product Availability

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

Specified by:
setTestGeometry in interface IConditionalAction
Specified by:
setTestGeometry in interface IConditionalAction2
Parameters:
ppiTestGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTestGeometry

public IGeometry getTestGeometry()
                          throws IOException,
                                 AutomationException
Geometry used for location trigger test.

Product Availability

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

Specified by:
getTestGeometry in interface IConditionalAction
Specified by:
getTestGeometry in interface IConditionalAction2
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReference

public void setSpatialReference(String pVal)
                         throws IOException,
                                AutomationException
String describing the Spatial Reference used by the Action.

Product Availability

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

Specified by:
setSpatialReference in interface IConditionalAction
Specified by:
setSpatialReference in interface IConditionalAction2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public String getSpatialReference()
                           throws IOException,
                                  AutomationException
String describing the Spatial Reference used by the Action.

Product Availability

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

Specified by:
getSpatialReference in interface IConditionalAction
Specified by:
getSpatialReference in interface IConditionalAction2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonSourceName

public IName getPolygonSourceName()
                           throws IOException,
                                  AutomationException
Name of a feature class containing polygons to test location trigger actions.

Product Availability

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

Specified by:
getPolygonSourceName in interface IConditionalAction2
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 ppiSourceName)
                               throws IOException,
                                      AutomationException
Name of a feature class containing polygons to test location trigger actions.

Product Availability

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

Specified by:
setPolygonSourceNameByRef in interface IConditionalAction2
Parameters:
ppiSourceName - 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.

isFavorQuery

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

Specified by:
isFavorQuery in interface IConditionalAction4
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFavorQuery

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

Specified by:
setFavorQuery in interface IConditionalAction4
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocationTriggerByRef

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

Specified by:
setLocationTriggerByRef in interface IConditionalAction4
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

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

Specified by:
getLocationTrigger in interface IConditionalAction4
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.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws IOException,
                   AutomationException
Notify a tracking action that lookup table values have changed.

Product Availability

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

Specified by:
update in interface IActionUpdate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFromDataDefinition

public void setFromDataDefinition(IDatasetDef piDataDef)
                           throws IOException,
                                  AutomationException
Set up the action based on a data definition.

Product Availability

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

Specified by:
setFromDataDefinition in interface IActionHelper
Parameters:
piDataDef - A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFromLayer

public void setFromLayer(IFeatureLayer piLayer)
                  throws IOException,
                         AutomationException
Set up the action based on a feature layer.

Product Availability

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

Specified by:
setFromLayer in interface IActionHelper
Parameters:
piLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initialize

public void initialize(String bstrDeveloperName,
                       String bstrTypeDescription,
                       double dVersion)
                throws IOException,
                       AutomationException
Initialize the Base or Child Action.

Product Availability

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

Specified by:
initialize in interface IActionSetup
Parameters:
bstrDeveloperName - The bstrDeveloperName (in)
bstrTypeDescription - The bstrTypeDescription (in)
dVersion - The dVersion (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetToDefaultState

public void resetToDefaultState()
                         throws IOException,
                                AutomationException
Reset the State information to default.

Product Availability

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

Specified by:
resetToDefaultState in interface IActionState
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.