com.esri.arcgis.trackinganalyst
Interface IMessageTemplate

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMessageTemplateProxy, MessageTemplate

public interface IMessageTemplate
extends Serializable

Provides access to properties and methods needed to support Email message content for the Email Alert actions.

Product Availability

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

Method Summary

String	esri_getSource() Dataset definition ID associated with the tracking service.
void	formatMessage(Object __MIDL__IMessageTemplate0000, String[] __MIDL__IMessageTemplate0001) Generated the formatted email message for the data (message or feature) provided.
String	getDateFormat() Date format to be used for a date field in the email message.
Object	getFieldsWithColumns() Field names and column index of fields used in the email altert action message body.
int	getSourceType() Indication if the source is the dataset definition or a feature.
String	getTemplate() Structured message template for use as an email altert action message body.
String	getTemplateName() Name of a message template containing an email alert message.
String	getTimeFormat() Time format to be used for a time field in the email message.
void	setDateFormat(String pVal) Date format to be used for a date field in the email message.
void	setFieldsWithColumns(Object pVal) Field names and column index of fields used in the email altert action message body.
void	setSource(String newVal) Dataset definition ID associated with the tracking service.
void	setSourceType(int pVal) Indication if the source is the dataset definition or a feature.
void	setTemplate(String pVal) Structured message template for use as an email altert action message body.
void	setTemplateName(String pVal) Name of a message template containing an email alert message.
void	setTimeFormat(String pVal) Time format to be used for a time field in the email message.

Method Detail

getTemplate

String getTemplate()
                   throws IOException,
                          AutomationException

Structured message template for use as an email altert action message body.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemplate

void setTemplate(String pVal)
                 throws IOException,
                        AutomationException

Structured message template for use as an email altert action message body.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplateName

String getTemplateName()
                       throws IOException,
                              AutomationException

Name of a message template containing an email alert message.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemplateName

void setTemplateName(String pVal)
                     throws IOException,
                            AutomationException

Name of a message template containing an email alert message.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceType

int getSourceType()
                  throws IOException,
                         AutomationException

Indication if the source is the dataset definition or a feature.

Product Availability

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

Returns:

A com.esri.arcgis.trackinganalyst.enumTemplateSourceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceType

void setSourceType(int pVal)
                   throws IOException,
                          AutomationException

Indication if the source is the dataset definition or a feature.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_getSource

String esri_getSource()
                      throws IOException,
                             AutomationException

Dataset definition ID associated with the tracking service.

Product Availability

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

Returns:

The newVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSource

void setSource(String newVal)
               throws IOException,
                      AutomationException

Dataset definition ID associated with the tracking service.

Product Availability

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

Parameters:

newVal - The newVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

formatMessage

void formatMessage(Object __MIDL__IMessageTemplate0000,
                   String[] __MIDL__IMessageTemplate0001)
                   throws IOException,
                          AutomationException

Generated the formatted email message for the data (message or feature) provided.

Product Availability

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

Parameters:

__MIDL__IMessageTemplate0000 - A reference to another Object (IUnknown) (in)

__MIDL__IMessageTemplate0001 - The __MIDL__IMessageTemplate0001 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDateFormat

String getDateFormat()
                     throws IOException,
                            AutomationException

Date format to be used for a date field in the email message.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDateFormat

void setDateFormat(String pVal)
                   throws IOException,
                          AutomationException

Date format to be used for a date field in the email message.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeFormat

String getTimeFormat()
                     throws IOException,
                            AutomationException

Time format to be used for a time field in the email message.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeFormat

void setTimeFormat(String pVal)
                   throws IOException,
                          AutomationException

Time format to be used for a time field in the email message.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldsWithColumns

Object getFieldsWithColumns()
                            throws IOException,
                                   AutomationException

Field names and column index of fields used in the email altert action message body.

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.

setFieldsWithColumns

void setFieldsWithColumns(Object pVal)
                          throws IOException,
                                 AutomationException

Field names and column index of fields used in the email altert action message body.

Product Availability

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

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.