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 actions that use strings containing message field values.

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.
String	formatMessage(Object dataObject) Generate the formatted message for the data (message or feature) provided.
String	getDateFormat() Date format to be used for a date field in the message.
Object	getFieldsWithColumns() Field names and column index of fields used in the action message.
int	getSourceType() Indication if the source is the dataset definition or a feature.
String	getTemplate() Structured message template for use as an action message output.
String	getTemplateName() Name of a message template.
String	getTimeFormat() Time format to be used for a time field in the message.
void	setDateFormat(String dateFormat) Date format to be used for a date field in the message.
void	setFieldsWithColumns(Object array) Field names and column index of fields used in the action message.
void	setSource(String datasetDefID) Dataset definition ID associated with the tracking service.
void	setSourceType(int type) Indication if the source is the dataset definition or a feature.
void	setTemplate(String unformatedMessage) Structured message template for use as an action message output.
void	setTemplateName(String name) Name of a message template.
void	setTimeFormat(String timeFormat) Time format to be used for a time field in the message.

Method Detail

getTemplate

String getTemplate()
                   throws IOException,
                          AutomationException

Structured message template for use as an action message output.

Product Availability

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

Returns:

The unformatedMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemplate

void setTemplate(String unformatedMessage)
                 throws IOException,
                        AutomationException

Structured message template for use as an action message output.

Product Availability

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

Parameters:

unformatedMessage - The unformatedMessage (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.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemplateName

void setTemplateName(String name)
                     throws IOException,
                            AutomationException

Name of a message template.

Product Availability

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

Parameters:

name - The name (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 type)
                   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:

type - 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 datasetDefID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSource

void setSource(String datasetDefID)
               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:

datasetDefID - The datasetDefID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

formatMessage

String formatMessage(Object dataObject)
                     throws IOException,
                            AutomationException

Generate the formatted message for the data (message or feature) provided.

Product Availability

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

Parameters:

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

Returns:

The formatedMessage

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

Product Availability

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

Returns:

The dateFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDateFormat

void setDateFormat(String dateFormat)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Parameters:

dateFormat - The dateFormat (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 message.

Product Availability

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

Returns:

The timeFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeFormat

void setTimeFormat(String timeFormat)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Parameters:

timeFormat - The timeFormat (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 action message.

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 array)
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Parameters:

array - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.