com.esri.arcgis.trackinganalyst
Class FilterAction

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

All Implemented Interfaces:

IAction, IActionEdit, IActionUpdate, IClone, IConditionalAction, IFilterAction, ILayerAction, IPersist, IPersistStream, IServAction, ISupportErrorInfo, java.io.Serializable

public class FilterAction

extends java.lang.Object

implements IFilterAction, ISupportErrorInfo, IAction, IActionEdit, ILayerAction, IServAction, IConditionalAction, IPersistStream, IClone, IActionUpdate

Controls settings and functionality for the filter action.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

FilterAction()
Constructs a FilterAction using ArcGIS Engine.

FilterAction(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	evaluate(java.lang.Object piObject, java.lang.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.
java.lang.String	getAlias() Allows user to specify or retrieve the alias name for this action.
IAction	getAsIAction() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IActionEdit	getAsIActionEdit() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IActionUpdate	getAsIActionUpdate() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IConditionalAction	getAsIConditionalAction() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IFilterAction	getAsIFilterAction() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ILayerAction	getAsILayerAction() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IServAction	getAsIServAction() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
java.lang.Object	getColumnList() The list of columns from the feature or the dataset definition.
java.lang.String	getDatasetDefinitionID() Value of the DatasetDefinitionID property.
java.lang.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	getFilterActionType() Indicates type of filter action: either Permit or Deny.
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.
java.lang.String	getHelpFile() The help file name for the page.
java.lang.String	getLabel() Allows user to specify or retreive tha label name for this action.
ILayer	getLayer() Tracking layer upon which the action is performed.
java.lang.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.
java.lang.String	getName() Developer-given name of the object.
java.lang.String	getPolygonSource() Not Implemented - Use the PolygonSourceName property of IConditionalAction2.
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.
java.lang.String	getQueryString() SQL query for an attribute trigger.
java.lang.String	getRulesDescription() Describes what the action will do.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
java.lang.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.
java.lang.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.
java.lang.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	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
boolean	isContinueProcessing() Indicates whether or not the processing engine should stop processing further actions in the action list after this action finishes processing.
void	isDirty() Supported Platforms
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	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 whether or not the processing engine should stop processing further actions in the action list after this action finishes processing.
void	load(IStream pstm) Supported Platforms
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setActionCategory(int pVal) Indicates the type of action to be applied to data.
void	setAlias(java.lang.String pbstrAlias) Allows user to specify or retrieve the alias name for this action.
void	setColumnList(java.lang.Object pVal) The list of columns from the feature or the dataset definition.
void	setDatasetDefinitionID(java.lang.String bstrDatasetDefID) Value of the DatasetDefinitionID property.
void	setDatasetDefinitionName(java.lang.String bstrDatasetDefName) Value of the DatasetDefinitionName property.
void	setEventIdColumnNumber(int iVal) Number of the column containing EventID information.
void	setFilterActionType(int pVal) Indicates type of filter action: either Permit or Deny.
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(java.lang.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	setLocationTriggerName(java.lang.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(java.lang.String pVal) Not Implemented - Use the PolygonSourceName property of IConditionalAction2.
void	setQueryString(java.lang.String pVal) SQL query for an attribute trigger.
void	setReadOnly(boolean rhs1) Indicates whether the action is specified as read-only.
void	setSpatialReference(java.lang.String pVal) String describing the Spatial Reference used by the Action.
void	setStopProcessing(boolean pbvarStopProcessing) Indicates whether or not 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

Constructor Detail

FilterAction

public FilterAction()
             throws java.io.IOException,
                    java.net.UnknownHostException

Constructs a FilterAction using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FilterAction

public FilterAction(java.lang.Object obj)
             throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a FilterAction using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to FilterAction.
FilterAction theFilterAction = (FilterAction) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIFilterAction

public IFilterAction getAsIFilterAction()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAction

public IAction getAsIAction()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIActionEdit

public IActionEdit getAsIActionEdit()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsILayerAction

public ILayerAction getAsILayerAction()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIServAction

public IServAction getAsIServAction()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIConditionalAction

public IConditionalAction getAsIConditionalAction()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIActionUpdate

public IActionUpdate getAsIActionUpdate()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getFilterActionType

public int getFilterActionType()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IFilterAction

Indicates type of filter action: either Permit or Deny.

Specified by:

getFilterActionType in interface IFilterAction

Returns:

A com.esri.arcgis.trackinganalyst.enumFilter constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setFilterActionType

public void setFilterActionType(int pVal)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IFilterAction

Indicates type of filter action: either Permit or Deny.

Specified by:

setFilterActionType in interface IFilterAction

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumFilter constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getVersion

public double getVersion()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IAction

Allows user to retrieve the version number for this action.

Description

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

Specified by:

getVersion in interface IAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAction

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.

Specified by:

getName in interface IAction

Returns:

The pbstrName

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getRulesDescription

public java.lang.String getRulesDescription()
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IAction

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.

Specified by:

getRulesDescription in interface IAction

Returns:

The pbstrRulesDescription

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isContinueProcessing

public boolean isContinueProcessing()
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IAction

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.

Specified by:

isContinueProcessing in interface IAction

Returns:

The pbvarContinueProcessing

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlias

public java.lang.String getAlias()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IAction

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.

Specified by:

getAlias in interface IAction

Returns:

The pbstrAlias

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setAlias

public void setAlias(java.lang.String pbstrAlias)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IAction

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.

Specified by:

setAlias in interface IAction

Parameters:

pbstrAlias - The pbstrAlias (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public java.lang.String getLabel()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IAction

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.

Specified by:

getLabel in interface IAction

Returns:

The pbstrLabel

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setLabel

public void setLabel(java.lang.String pbstrLabel)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IAction

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.

Specified by:

setLabel in interface IAction

Parameters:

pbstrLabel - The pbstrLabel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public java.lang.String getType()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAction

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.

Specified by:

getType in interface IAction

Returns:

The pbstrType

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IAction

Indicates whether or not an action in the action list is enabled for processing.

Specified by:

isEnabled in interface IAction

Returns:

The pbvarIsEnabled

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setIsEnabled

public void setIsEnabled(boolean pbvarIsEnabled)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IAction

Indicates whether or not an action in the action list is enabled for processing.

Specified by:

setIsEnabled in interface IAction

Parameters:

pbvarIsEnabled - The pbvarIsEnabled (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStopProcessing

public void setStopProcessing(boolean pbvarStopProcessing)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IAction

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. This enables the ContinueProcessing property to return a VARIANT_FALSE if no further processing should take place.

Specified by:

setStopProcessing in interface IAction

Parameters:

pbvarStopProcessing - The pbvarStopProcessing (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

evaluate

public void evaluate(java.lang.Object piObject,
                     java.lang.Object[] pvarReturnedObjects)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IAction

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.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStopProcessing

public boolean isStopProcessing()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAction

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. This enables the ContinueProcessing property to return a VARIANT_FALSE if no furtherprocessing should take place.

Specified by:

isStopProcessing in interface IAction

Returns:

The pbvarStopProcessing

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEvaluationCount

public int getEvaluationCount()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IAction

Number of times this action has been evaluated.

Description

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

Specified by:

getEvaluationCount in interface IAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getStopProcessingCount

public int getStopProcessingCount()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IAction

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.

Specified by:

getStopProcessingCount in interface IAction

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilteredCount

public int getFilteredCount()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IAction

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.

Specified by:

getFilteredCount in interface IAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getModifiedCount

public int getModifiedCount()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IAction

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.

Specified by:

getModifiedCount in interface IAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getProcessedCount

public int getProcessedCount()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAction

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.

Specified by:

getProcessedCount in interface IAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

clearCounts

public void clearCounts()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IAction

Clears all the internal counters for this action.

Description

This property clears all the internal counters for this action.

Specified by:

clearCounts in interface IAction

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getActionCategory

public int getActionCategory()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAction

Indicates the type of action to be applied to data.

Specified by:

getActionCategory in interface IAction

Returns:

A com.esri.arcgis.trackinganalyst.enumActionCategory constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActionCategory

public void setActionCategory(int pVal)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IAction

Indicates the type of action to be applied to data.

Specified by:

setActionCategory in interface IAction

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

defaultAction

public void defaultAction()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IActionEdit

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.

Specified by:

defaultAction in interface IActionEdit

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

edit

public void edit(int hParentWindowHandle,
                 ISet piObjectSet)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IActionEdit

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.

Specified by:

edit in interface IActionEdit

Parameters:

hParentWindowHandle - The hParentWindowHandle (in)

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getPreviewImage

public int getPreviewImage()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IActionEdit

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.

Specified by:

getPreviewImage in interface IActionEdit

Returns:

The phBitmap

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getHelpFile

public java.lang.String getHelpFile()
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IActionEdit

The help file name for the page.

Description

This property controls the help file name for the page.

Specified by:

getHelpFile in interface IActionEdit

Returns:

The pbstrHelpFile

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

public int getHelpContextID(int lControlID)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IActionEdit

The help context ID for the specified control on the page.

Description

This property controls the help context ID for the specified control on the page.

Specified by:

getHelpContextID in interface IActionEdit

Parameters:

lControlID - The lControlID (in)

Returns:

The plHelpID

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setReadOnly

public void setReadOnly(boolean rhs1)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IActionEdit

Indicates whether the action is specified as read-only.

Specified by:

setReadOnly in interface IActionEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: ILayerAction

Tracking layer upon which the action is performed.

Specified by:

getLayer in interface ILayerAction

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerByRef

public void setLayerByRef(ILayer pVal)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: ILayerAction

Tracking layer upon which the action is performed.

Specified by:

setLayerByRef in interface ILayerAction

Parameters:

pVal - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getEventIdColumnNumber

public int getEventIdColumnNumber()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: ILayerAction

Number of the column containing EventID information.

Specified by:

getEventIdColumnNumber in interface ILayerAction

Returns:

The iVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEventIdColumnNumber

public void setEventIdColumnNumber(int iVal)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: ILayerAction

Number of the column containing EventID information.

Specified by:

setEventIdColumnNumber in interface ILayerAction

Parameters:

iVal - The iVal (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getDatasetDefinitionName

public java.lang.String getDatasetDefinitionName()
                                          throws java.io.IOException,
                                                 AutomationException

Description copied from interface: IServAction

Value of the DatasetDefinitionName property.

Description

Returns the value of the DatasetDefinitionName property.

Specified by:

getDatasetDefinitionName in interface IServAction

Returns:

The bstrDatasetDefName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetDefinitionName

public void setDatasetDefinitionName(java.lang.String bstrDatasetDefName)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IServAction

Value of the DatasetDefinitionName property.

Description

Sets the value of the DatasetDefinitionName property.

Specified by:

setDatasetDefinitionName in interface IServAction

Parameters:

bstrDatasetDefName - The bstrDatasetDefName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetDefinitionID

public java.lang.String getDatasetDefinitionID()
                                        throws java.io.IOException,
                                               AutomationException

Description copied from interface: IServAction

Value of the DatasetDefinitionID property.

Description

Returns the value of the DatasetDefinitionID property.

Specified by:

getDatasetDefinitionID in interface IServAction

Returns:

The bstrDatasetDefID

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setDatasetDefinitionID

public void setDatasetDefinitionID(java.lang.String bstrDatasetDefID)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IServAction

Value of the DatasetDefinitionID property.

Description

Sets the value of the DatasetDefinitionID property.

Specified by:

setDatasetDefinitionID in interface IServAction

Parameters:

bstrDatasetDefID - The bstrDatasetDefID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getGeometryColumnNumber

public int getGeometryColumnNumber()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IServAction

Value of the GeometryColumnNumber property.

Description

Returns the value of the GeometryColumnNumber property.

Specified by:

getGeometryColumnNumber in interface IServAction

Returns:

The iVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryColumnNumber

public void setGeometryColumnNumber(int iVal)
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IServAction

Value of the GeometryColumnNumber property.

Description

Sets the value of the GeometryColumnNumber property.

Specified by:

setGeometryColumnNumber in interface IServAction

Parameters:

iVal - The iVal (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getTrackIdColumnNumber

public int getTrackIdColumnNumber()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IServAction

Value of the TrackIdColumnNumber property.

Specified by:

getTrackIdColumnNumber in interface IServAction

Returns:

The iVal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setTrackIdColumnNumber

public void setTrackIdColumnNumber(int iVal)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IServAction

Value of the TrackIdColumnNumber property.

Specified by:

setTrackIdColumnNumber in interface IServAction

Parameters:

iVal - The iVal (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getGeometryColumnType

public int getGeometryColumnType()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IServAction

Type of geomety object contained in the geometry column.

Specified by:

getGeometryColumnType in interface IServAction

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setGeometryColumnType

public void setGeometryColumnType(int iVal)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IServAction

Type of geomety object contained in the geometry column.

Specified by:

setGeometryColumnType in interface IServAction

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTriggerType

public int getTriggerType()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IConditionalAction

Type of trigger used to execute an action: Always, Location, Attribute, or Attribute and Location.

Specified by:

getTriggerType in interface IConditionalAction

Returns:

A com.esri.arcgis.trackinganalyst.enumTriggerType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTriggerType

public void setTriggerType(int pVal)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IConditionalAction

Type of trigger used to execute an action: Always, Location, Attribute, or Attribute and Location.

Specified by:

setTriggerType in interface IConditionalAction

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTriggerType

public int getLocationTriggerType()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IConditionalAction

Spatial relationship of an intrinsic location trigger.

Specified by:

getLocationTriggerType in interface IConditionalAction

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setLocationTriggerType

public void setLocationTriggerType(int pVal)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IConditionalAction

Spatial relationship of an intrinsic location trigger.

Specified by:

setLocationTriggerType in interface IConditionalAction

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getQueryString

public java.lang.String getQueryString()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IConditionalAction

SQL query for an attribute trigger.

Specified by:

getQueryString in interface IConditionalAction

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryString

public void setQueryString(java.lang.String pVal)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IConditionalAction

SQL query for an attribute trigger.

Specified by:

setQueryString in interface IConditionalAction

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTriggerLayer

public ILayer getTriggerLayer()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IConditionalAction

Layer containing location test polygons.

Specified by:

getTriggerLayer in interface IConditionalAction

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTriggerLayerByRef

public void setTriggerLayerByRef(ILayer pVal)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IConditionalAction

Layer containing location test polygons.

Specified by:

setTriggerLayerByRef in interface IConditionalAction

Parameters:

pVal - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isNegateLocationTrigger

public boolean isNegateLocationTrigger()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IConditionalAction

Indicates whether or not to negate results of the location trigger.

Specified by:

isNegateLocationTrigger in interface IConditionalAction

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNegateLocationTrigger

public void setNegateLocationTrigger(boolean pVal)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IConditionalAction

Indicates whether or not to negate results of the location trigger.

Specified by:

setNegateLocationTrigger in interface IConditionalAction

Parameters:

pVal - The pVal (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getPolygonSource

public java.lang.String getPolygonSource()
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IConditionalAction

Not Implemented - Use the PolygonSourceName property of IConditionalAction2.

Specified by:

getPolygonSource in interface IConditionalAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setPolygonSource

public void setPolygonSource(java.lang.String pVal)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IConditionalAction

Not Implemented - Use the PolygonSourceName property of IConditionalAction2.

Specified by:

setPolygonSource in interface IConditionalAction

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnList

public java.lang.Object getColumnList()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IConditionalAction

The list of columns from the feature or the dataset definition.

Specified by:

getColumnList in interface IConditionalAction

Returns:

A Variant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setColumnList

public void setColumnList(java.lang.Object pVal)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IConditionalAction

The list of columns from the feature or the dataset definition.

Specified by:

setColumnList in interface IConditionalAction

Parameters:

pVal - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getTriggerLayerName

public java.lang.String getTriggerLayerName()
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IConditionalAction

Name of layer containing location test polygons.

Specified by:

getTriggerLayerName in interface IConditionalAction

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationTriggerName

public void setLocationTriggerName(java.lang.String pVal)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IConditionalAction

Name of the custom location trigger for the action if one is being used.

Specified by:

setLocationTriggerName in interface IConditionalAction

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationTriggerName

public java.lang.String getLocationTriggerName()
                                        throws java.io.IOException,
                                               AutomationException

Description copied from interface: IConditionalAction

Name of the custom location trigger for the action if one is being used.

Specified by:

getLocationTriggerName in interface IConditionalAction

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setTestGeometry

public void setTestGeometry(IGeometry ppiTestGeometry)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IConditionalAction

Geometry used for location trigger test.

Specified by:

setTestGeometry in interface IConditionalAction

Parameters:

ppiTestGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getTestGeometry

public IGeometry getTestGeometry()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IConditionalAction

Geometry used for location trigger test.

Specified by:

getTestGeometry in interface IConditionalAction

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReference

public void setSpatialReference(java.lang.String pVal)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IConditionalAction

String describing the Spatial Reference used by the Action.

Specified by:

setSpatialReference in interface IConditionalAction

Parameters:

pVal - The pVal (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getSpatialReference

public java.lang.String getSpatialReference()
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IConditionalAction

String describing the Spatial Reference used by the Action.

Specified by:

getSpatialReference in interface IConditionalAction

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClone

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

update

public void update()
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IActionUpdate

Notify a tracking action that lookup table values have changed.

Specified by:

update in interface IActionUpdate

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.