com.esri.arcgis.trackinganalyst
Interface IMessageTemplate

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMessageTemplateProxy, MessageTemplate

public interface IMessageTemplate
extends java.io.Serializable

COM Interface 'IMessageTemplate'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to properties and methods needed to support actions that use strings containing message field values.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDd100dbd8_9cc2_4de1_8c26_d030e4b0f938
static int	xxDummy Deprecated. Internal use only

Method Summary

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

Field Detail

IIDd100dbd8_9cc2_4de1_8c26_d030e4b0f938

static final int IIDd100dbd8_9cc2_4de1_8c26_d030e4b0f938

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getTemplate

java.lang.String getTemplate()
                             throws java.io.IOException,
                                    AutomationException

Structured message template for use as an action message output.

Returns:

The unformatedMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemplate

void setTemplate(java.lang.String unformatedMessage)
                 throws java.io.IOException,
                        AutomationException

Structured message template for use as an action message output.

Parameters:

unformatedMessage - The unformatedMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemplateName

java.lang.String getTemplateName()
                                 throws java.io.IOException,
                                        AutomationException

Name of a message template.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemplateName

void setTemplateName(java.lang.String name)
                     throws java.io.IOException,
                            AutomationException

Name of a message template.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSourceType

int getSourceType()
                  throws java.io.IOException,
                         AutomationException

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

Returns:

A com.esri.arcgis.trackinganalyst.enumTemplateSourceType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSourceType

void setSourceType(int type)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_getSource

java.lang.String esri_getSource()
                                throws java.io.IOException,
                                       AutomationException

Dataset definition ID associated with the tracking service.

Returns:

The datasetDefID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSource

void setSource(java.lang.String datasetDefID)
               throws java.io.IOException,
                      AutomationException

Dataset definition ID associated with the tracking service.

Parameters:

datasetDefID - The datasetDefID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

formatMessage

java.lang.String formatMessage(java.lang.Object dataObject)
                               throws java.io.IOException,
                                      AutomationException

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

Parameters:

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

Returns:

The formatedMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDateFormat

java.lang.String getDateFormat()
                               throws java.io.IOException,
                                      AutomationException

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

Returns:

The dateFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDateFormat

void setDateFormat(java.lang.String dateFormat)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

dateFormat - The dateFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeFormat

java.lang.String getTimeFormat()
                               throws java.io.IOException,
                                      AutomationException

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

Returns:

The timeFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeFormat

void setTimeFormat(java.lang.String timeFormat)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

timeFormat - The timeFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldsWithColumns

java.lang.Object getFieldsWithColumns()
                                      throws java.io.IOException,
                                             AutomationException

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

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldsWithColumns

void setFieldsWithColumns(java.lang.Object array)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

array - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.