com.esri.arcgis.trackinganalyst
Class DataSummaryAction

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

All Implemented Interfaces:

IAction, IActionState, IConditionalAction, IConditionalAction2, IConditionalAction4, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IActionEdit, IActionEvaluate, IActionHelper, IActionSetup, IActionUpdate, IDataSummaryAction, IEmailProperties, IServAction, Externalizable, Serializable

public class DataSummaryAction
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataSummaryAction, IAction, IActionEdit, IActionEvaluate, IClone, IPersist, IPersistStream, ISupportErrorInfo, IConditionalAction, IConditionalAction2, IConditionalAction4, IActionSetup, IActionUpdate, IActionHelper, IActionState, IServAction, IEmailProperties, IDocumentVersionSupportGEN, Externalizable

Controls the properties and methods needed for the Data Summary Action

Product Availability

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

See Also:

Serialized Form

Constructor Summary

DataSummaryAction()
Constructs a DataSummaryAction using ArcGIS Engine.

DataSummaryAction(Object obj)
Construct a DataSummaryAction using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	clearCounts() Clears all the internal counters for this action.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
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	getActionSpecificRuleText() The text that describes the basic purpose and reason for the action, such as with tag actions what is being tagged.
String	getAlias() Allows user to specify or retrieve the alias name for this action.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
Object	getCollectionInterval() property CollectionInterval
int	getColumnCount() method GetColumnCount
Object	getColumnList() The list of columns from the feature or the dataset definition.
String	getColumnName(int columnIndex) method GetColumnName
int	getColumnType(int columnIndex) method GetColumnType
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	getFilteredCount() Number of times this action has returned S_ACTIONPROCESSOR_MSG_FILTERED.
String	getFromDomain() property FromDomain
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.
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.
String	getPrinterName() property PrinterName
int	getProcessedCount() Number of times this action has returned S_ACTIONPROCESSOR_MSG_PROCESSED.
String	getQueryString() SQL query for an attribute trigger.
String	getRecipientEmailAddress() property RecipientEmailAddress
String	getReport() method GetReport
String	getReportDirectory() property ReportDirectory
Object	getReportInterval() property ReportInterval
String	getReportTitle() property ReportTitle
String	getRulesDescription() Describes what the action will do.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getSMTPServer() property SMTPServer
String	getSpatialReference() String describing the Spatial Reference used by the Action.
int	getStopProcessingCount() Number of times this action has returned S_ACTIONPROCESSOR_MSG_STOPPROCESSING.
String	getSuggestFromUserName() property SuggestFromUserName
int	getSummaryCollectionType(int columnNumber) property SummaryCollectionType
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.
int	getValidSummaryCollectionType(int columnIndex) method GetValidSummaryCollectionType
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.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isContinueProcessing() Indicates whether or not the processing engine should stop processing further actions in the action list after this action finishes processing.
boolean	isDeliverEmailReport() property DeliverEmailReport
boolean	isDeliverFileReport() property DeliverFileReport
boolean	isDeliverPrintedReport() property DeliverPrintedReport
void	isDirty() isDirty
boolean	isEnabled() Indicates whether or not an action in the action list is enabled for processing.
boolean	isEqual(IClone other) Indicates if 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) Indicates if 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.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	performFeatureAction(int bResult, IFeature piFeature, Object[] pvarReturnedObjects) Perform the Action specified by the base action or condition.
void	performMessageAction(int bResult, IDataMessage piMessage, Object[] pvarReturnedObjects) Perform the Action specified by the base action or condition.
void	readExternal(ObjectInput in)
void	resetToDefaultState() Reset the State information to default.
void	save(IStream pstm, int fClearDirty) save
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	setCollectionDatasetDefinition(IDatasetDef dataSetDefinition) method SetCollectionDatasetDefinition
void	setCollectionInterval(Object collectionInterval) property CollectionInterval
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	setDeliverEmailReport(boolean deliverEmailReport) property DeliverEmailReport
void	setDeliverFileReport(boolean deliverFileReport) property DeliverFileReport
void	setDeliverPrintedReport(boolean deliverPrintedReport) property DeliverPrintedReport
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	setFromDomain(String pVal) property FromDomain
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	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	setPrinterName(String printerName) property PrinterName
void	setQueryString(String pVal) SQL query for an attribute trigger.
void	setReadOnly(boolean rhs1) Indicates whether the action is specified as read-only.
void	setRecipientEmailAddress(String recipientEmailAddress) property RecipientEmailAddress
void	setReportDirectory(String reportDirectory) property ReportDirectory
void	setReportInterval(Object reportInterval) property ReportInterval
void	setReportTitle(String reportTitle) property ReportTitle
void	setSMTPServer(String pVal) property SMTPServer
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	setSummaryCollectionType(int columnNumber, int summaryCollectionType) property SummaryCollectionType
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.
void	writeExternal(ObjectOutput out)

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

DataSummaryAction

public DataSummaryAction()
                  throws IOException,
                         UnknownHostException

Constructs a DataSummaryAction using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DataSummaryAction

public DataSummaryAction(Object obj)
                  throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems DataSummaryAction theDataSummaryAction = (DataSummaryAction) obj;

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

getReportTitle

public String getReportTitle()
                      throws IOException,
                             AutomationException

property ReportTitle

Product Availability

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

Specified by:

getReportTitle in interface IDataSummaryAction

Returns:

The reportTitle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportTitle

public void setReportTitle(String reportTitle)
                    throws IOException,
                           AutomationException

property ReportTitle

Product Availability

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

Specified by:

setReportTitle in interface IDataSummaryAction

Parameters:

reportTitle - The reportTitle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValidSummaryCollectionType

public int getValidSummaryCollectionType(int columnIndex)
                                  throws IOException,
                                         AutomationException

method GetValidSummaryCollectionType

Product Availability

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

Specified by:

getValidSummaryCollectionType in interface IDataSummaryAction

Parameters:

columnIndex - The columnIndex (in)

Returns:

The validSummaryType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReport

public String getReport()
                 throws IOException,
                        AutomationException

method GetReport

Product Availability

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

Specified by:

getReport in interface IDataSummaryAction

Returns:

The report

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCollectionInterval

public Object getCollectionInterval()
                             throws IOException,
                                    AutomationException

property CollectionInterval

Product Availability

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

Specified by:

getCollectionInterval in interface IDataSummaryAction

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCollectionInterval

public void setCollectionInterval(Object collectionInterval)
                           throws IOException,
                                  AutomationException

property CollectionInterval

Product Availability

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

Specified by:

setCollectionInterval in interface IDataSummaryAction

Parameters:

collectionInterval - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReportInterval

public Object getReportInterval()
                         throws IOException,
                                AutomationException

property ReportInterval

Product Availability

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

Specified by:

getReportInterval in interface IDataSummaryAction

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportInterval

public void setReportInterval(Object reportInterval)
                       throws IOException,
                              AutomationException

property ReportInterval

Product Availability

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

Specified by:

setReportInterval in interface IDataSummaryAction

Parameters:

reportInterval - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCollectionDatasetDefinition

public void setCollectionDatasetDefinition(IDatasetDef dataSetDefinition)
                                    throws IOException,
                                           AutomationException

method SetCollectionDatasetDefinition

Product Availability

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

Specified by:

setCollectionDatasetDefinition in interface IDataSummaryAction

Parameters:

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

getSummaryCollectionType

public int getSummaryCollectionType(int columnNumber)
                             throws IOException,
                                    AutomationException

property SummaryCollectionType

Product Availability

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

Specified by:

getSummaryCollectionType in interface IDataSummaryAction

Parameters:

columnNumber - The columnNumber (in)

Returns:

The summaryCollectionType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSummaryCollectionType

public void setSummaryCollectionType(int columnNumber,
                                     int summaryCollectionType)
                              throws IOException,
                                     AutomationException

property SummaryCollectionType

Product Availability

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

Specified by:

setSummaryCollectionType in interface IDataSummaryAction

Parameters:

columnNumber - The columnNumber (in)

summaryCollectionType - The summaryCollectionType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnCount

public int getColumnCount()
                   throws IOException,
                          AutomationException

method GetColumnCount

Product Availability

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

Specified by:

getColumnCount in interface IDataSummaryAction

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnName

public String getColumnName(int columnIndex)
                     throws IOException,
                            AutomationException

method GetColumnName

Product Availability

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

Specified by:

getColumnName in interface IDataSummaryAction

Parameters:

columnIndex - The columnIndex (in)

Returns:

The columnName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnType

public int getColumnType(int columnIndex)
                  throws IOException,
                         AutomationException

method GetColumnType

Product Availability

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

Specified by:

getColumnType in interface IDataSummaryAction

Parameters:

columnIndex - The columnIndex (in)

Returns:

A com.esri.arcgis.trackinganalyst.enumColumnType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRecipientEmailAddress

public String getRecipientEmailAddress()
                                throws IOException,
                                       AutomationException

property RecipientEmailAddress

Product Availability

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

Specified by:

getRecipientEmailAddress in interface IDataSummaryAction

Returns:

The recipientEmailAddress

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecipientEmailAddress

public void setRecipientEmailAddress(String recipientEmailAddress)
                              throws IOException,
                                     AutomationException

property RecipientEmailAddress

Product Availability

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

Specified by:

setRecipientEmailAddress in interface IDataSummaryAction

Parameters:

recipientEmailAddress - The recipientEmailAddress (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReportDirectory

public String getReportDirectory()
                          throws IOException,
                                 AutomationException

property ReportDirectory

Product Availability

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

Specified by:

getReportDirectory in interface IDataSummaryAction

Returns:

The reportDirectory

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportDirectory

public void setReportDirectory(String reportDirectory)
                        throws IOException,
                               AutomationException

property ReportDirectory

Product Availability

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

Specified by:

setReportDirectory in interface IDataSummaryAction

Parameters:

reportDirectory - The reportDirectory (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDeliverEmailReport

public boolean isDeliverEmailReport()
                             throws IOException,
                                    AutomationException

property DeliverEmailReport

Product Availability

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

Specified by:

isDeliverEmailReport in interface IDataSummaryAction

Returns:

The deliverEmailReport

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeliverEmailReport

public void setDeliverEmailReport(boolean deliverEmailReport)
                           throws IOException,
                                  AutomationException

property DeliverEmailReport

Product Availability

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

Specified by:

setDeliverEmailReport in interface IDataSummaryAction

Parameters:

deliverEmailReport - The deliverEmailReport (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDeliverFileReport

public boolean isDeliverFileReport()
                            throws IOException,
                                   AutomationException

property DeliverFileReport

Product Availability

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

Specified by:

isDeliverFileReport in interface IDataSummaryAction

Returns:

The deliverFileReport

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeliverFileReport

public void setDeliverFileReport(boolean deliverFileReport)
                          throws IOException,
                                 AutomationException

property DeliverFileReport

Product Availability

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

Specified by:

setDeliverFileReport in interface IDataSummaryAction

Parameters:

deliverFileReport - The deliverFileReport (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDeliverPrintedReport

public boolean isDeliverPrintedReport()
                               throws IOException,
                                      AutomationException

property DeliverPrintedReport

Product Availability

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

Specified by:

isDeliverPrintedReport in interface IDataSummaryAction

Returns:

The deliverPrintedReport

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeliverPrintedReport

public void setDeliverPrintedReport(boolean deliverPrintedReport)
                             throws IOException,
                                    AutomationException

property DeliverPrintedReport

Product Availability

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

Specified by:

setDeliverPrintedReport in interface IDataSummaryAction

Parameters:

deliverPrintedReport - The deliverPrintedReport (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrinterName

public String getPrinterName()
                      throws IOException,
                             AutomationException

property PrinterName

Product Availability

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

Specified by:

getPrinterName in interface IDataSummaryAction

Returns:

The printerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrinterName

public void setPrinterName(String printerName)
                    throws IOException,
                           AutomationException

property PrinterName

Product Availability

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

Specified by:

setPrinterName in interface IDataSummaryAction

Parameters:

printerName - The printerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersion

public double getVersion()
                  throws IOException,
                         AutomationException

Allows user to retrieve the version number for this action.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

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.

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Product Availability

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

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.

Specified by:

getActionCategory in interface IAction

Returns:

A com.esri.arcgis.carto.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.

Specified by:

setActionCategory in interface IAction

Parameters:

pVal - A com.esri.arcgis.carto.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. piObjectSet is the object set that needs to be edited.

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.

getActionSpecificRuleText

public String getActionSpecificRuleText()
                                 throws IOException,
                                        AutomationException

The text that describes the basic purpose and reason for the action, such as with tag actions what is being tagged.

Product Availability

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

Specified by:

getActionSpecificRuleText in interface IActionEvaluate

Returns:

The pbstrActionSpecificRuleText

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

performFeatureAction

public void performFeatureAction(int bResult,
                                 IFeature piFeature,
                                 Object[] pvarReturnedObjects)
                          throws IOException,
                                 AutomationException

Perform the Action specified by the base action or condition.

Product Availability

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

Specified by:

performFeatureAction in interface IActionEvaluate

Parameters:

bResult - The bResult (in)

piFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (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.

performMessageAction

public void performMessageAction(int bResult,
                                 IDataMessage piMessage,
                                 Object[] pvarReturnedObjects)
                          throws IOException,
                                 AutomationException

Perform the Action specified by the base action or condition.

Product Availability

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

Specified by:

performMessageAction in interface IActionEvaluate

Parameters:

bResult - The bResult (in)

piMessage - A reference to a com.esri.arcgis.geodatabaseextensions.IDataMessage (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.

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

Indicates if 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

Indicates if 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.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (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.

Specified by:

getTriggerType in interface IConditionalAction

Specified by:

getTriggerType in interface IConditionalAction2

Returns:

A com.esri.arcgis.carto.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.

Specified by:

setTriggerType in interface IConditionalAction

Specified by:

setTriggerType in interface IConditionalAction2

Parameters:

pVal - A com.esri.arcgis.carto.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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Product Availability

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

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.

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.

Product Availability

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

Specified by:

setLocationTriggerByRef in interface IConditionalAction4

Parameters:

ppLocationTrigger - A reference to a com.esri.arcgis.carto.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.

Specified by:

getLocationTrigger in interface IConditionalAction4

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

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.

resetToDefaultState

public void resetToDefaultState()
                         throws IOException,
                                AutomationException

Reset the State information to default.

Product Availability

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

Specified by:

resetToDefaultState in interface IActionState

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.

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.

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.

getSMTPServer

public String getSMTPServer()
                     throws IOException,
                            AutomationException

property SMTPServer

Product Availability

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

Specified by:

getSMTPServer in interface IEmailProperties

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSMTPServer

public void setSMTPServer(String pVal)
                   throws IOException,
                          AutomationException

property SMTPServer

Product Availability

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

Specified by:

setSMTPServer in interface IEmailProperties

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromDomain

public String getFromDomain()
                     throws IOException,
                            AutomationException

property FromDomain

Product Availability

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

Specified by:

getFromDomain in interface IEmailProperties

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromDomain

public void setFromDomain(String pVal)
                   throws IOException,
                          AutomationException

property FromDomain

Product Availability

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

Specified by:

setFromDomain in interface IEmailProperties

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSuggestFromUserName

public String getSuggestFromUserName()
                              throws IOException,
                                     AutomationException

property SuggestFromUserName

Product Availability

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

Specified by:

getSuggestFromUserName in interface IEmailProperties

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException