com.esri.arcgis.trackinganalyst
Interface IDataSummaryAction

All Superinterfaces:

Serializable

All Known Implementing Classes:

DataSummaryAction, IDataSummaryActionProxy

public interface IDataSummaryAction
extends Serializable

IDataSummaryAction Interface

Product Availability

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

Method Summary

Object	getCollectionInterval() property CollectionInterval
int	getColumnCount() method GetColumnCount
String	getColumnName(int columnIndex) method GetColumnName
int	getColumnType(int columnIndex) method GetColumnType
String	getPrinterName() property PrinterName
String	getRecipientEmailAddress() property RecipientEmailAddress
String	getReport() method GetReport
String	getReportDirectory() property ReportDirectory
Object	getReportInterval() property ReportInterval
String	getReportTitle() property ReportTitle
int	getSummaryCollectionType(int columnNumber) property SummaryCollectionType
int	getValidSummaryCollectionType(int columnIndex) method GetValidSummaryCollectionType
boolean	isDeliverEmailReport() property DeliverEmailReport
boolean	isDeliverFileReport() property DeliverFileReport
boolean	isDeliverPrintedReport() property DeliverPrintedReport
void	setCollectionDatasetDefinition(IDatasetDef dataSetDefinition) method SetCollectionDatasetDefinition
void	setCollectionInterval(Object collectionInterval) property CollectionInterval
void	setDeliverEmailReport(boolean deliverEmailReport) property DeliverEmailReport
void	setDeliverFileReport(boolean deliverFileReport) property DeliverFileReport
void	setDeliverPrintedReport(boolean deliverPrintedReport) property DeliverPrintedReport
void	setPrinterName(String printerName) property PrinterName
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	setSummaryCollectionType(int columnNumber, int summaryCollectionType) property SummaryCollectionType

Method Detail

getReportTitle

String getReportTitle()
                      throws IOException,
                             AutomationException

property ReportTitle

Product Availability

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

Returns:

The reportTitle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportTitle

void setReportTitle(String reportTitle)
                    throws IOException,
                           AutomationException

property ReportTitle

Product Availability

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

Parameters:

reportTitle - The reportTitle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValidSummaryCollectionType

int getValidSummaryCollectionType(int columnIndex)
                                  throws IOException,
                                         AutomationException

method GetValidSummaryCollectionType

Product Availability

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

Parameters:

columnIndex - The columnIndex (in)

Returns:

The validSummaryType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReport

String getReport()
                 throws IOException,
                        AutomationException

method GetReport

Product Availability

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

Returns:

The report

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCollectionInterval

Object getCollectionInterval()
                             throws IOException,
                                    AutomationException

property CollectionInterval

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCollectionInterval

void setCollectionInterval(Object collectionInterval)
                           throws IOException,
                                  AutomationException

property CollectionInterval

Product Availability

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

Parameters:

collectionInterval - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReportInterval

Object getReportInterval()
                         throws IOException,
                                AutomationException

property ReportInterval

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportInterval

void setReportInterval(Object reportInterval)
                       throws IOException,
                              AutomationException

property ReportInterval

Product Availability

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

Parameters:

reportInterval - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCollectionDatasetDefinition

void setCollectionDatasetDefinition(IDatasetDef dataSetDefinition)
                                    throws IOException,
                                           AutomationException

method SetCollectionDatasetDefinition

Product Availability

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

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

int getSummaryCollectionType(int columnNumber)
                             throws IOException,
                                    AutomationException

property SummaryCollectionType

Product Availability

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

Parameters:

columnNumber - The columnNumber (in)

Returns:

The summaryCollectionType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSummaryCollectionType

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.

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

int getColumnCount()
                   throws IOException,
                          AutomationException

method GetColumnCount

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnName

String getColumnName(int columnIndex)
                     throws IOException,
                            AutomationException

method GetColumnName

Product Availability

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

Parameters:

columnIndex - The columnIndex (in)

Returns:

The columnName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnType

int getColumnType(int columnIndex)
                  throws IOException,
                         AutomationException

method GetColumnType

Product Availability

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

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

String getRecipientEmailAddress()
                                throws IOException,
                                       AutomationException

property RecipientEmailAddress

Product Availability

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

Returns:

The recipientEmailAddress

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecipientEmailAddress

void setRecipientEmailAddress(String recipientEmailAddress)
                              throws IOException,
                                     AutomationException

property RecipientEmailAddress

Product Availability

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

Parameters:

recipientEmailAddress - The recipientEmailAddress (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReportDirectory

String getReportDirectory()
                          throws IOException,
                                 AutomationException

property ReportDirectory

Product Availability

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

Returns:

The reportDirectory

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportDirectory

void setReportDirectory(String reportDirectory)
                        throws IOException,
                               AutomationException

property ReportDirectory

Product Availability

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

Parameters:

reportDirectory - The reportDirectory (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDeliverEmailReport

boolean isDeliverEmailReport()
                             throws IOException,
                                    AutomationException

property DeliverEmailReport

Product Availability

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

Returns:

The deliverEmailReport

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeliverEmailReport

void setDeliverEmailReport(boolean deliverEmailReport)
                           throws IOException,
                                  AutomationException

property DeliverEmailReport

Product Availability

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

Parameters:

deliverEmailReport - The deliverEmailReport (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDeliverFileReport

boolean isDeliverFileReport()
                            throws IOException,
                                   AutomationException

property DeliverFileReport

Product Availability

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

Returns:

The deliverFileReport

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeliverFileReport

void setDeliverFileReport(boolean deliverFileReport)
                          throws IOException,
                                 AutomationException

property DeliverFileReport

Product Availability

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

Parameters:

deliverFileReport - The deliverFileReport (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDeliverPrintedReport

boolean isDeliverPrintedReport()
                               throws IOException,
                                      AutomationException

property DeliverPrintedReport

Product Availability

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

Returns:

The deliverPrintedReport

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeliverPrintedReport

void setDeliverPrintedReport(boolean deliverPrintedReport)
                             throws IOException,
                                    AutomationException

property DeliverPrintedReport

Product Availability

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

Parameters:

deliverPrintedReport - The deliverPrintedReport (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrinterName

String getPrinterName()
                      throws IOException,
                             AutomationException

property PrinterName

Product Availability

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

Returns:

The printerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrinterName

void setPrinterName(String printerName)
                    throws IOException,
                           AutomationException

property PrinterName

Product Availability

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

Parameters:

printerName - The printerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.