com.esri.arcgis.trackinganalyst
Class IMessageTemplateProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.trackinganalyst.IMessageTemplateProxy

All Implemented Interfaces:

IMessageTemplate, Externalizable, Serializable

public class IMessageTemplateProxy
extends com.esri.arcgis.interop.Dispatch
implements IMessageTemplate, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IMessageTemplateProxy()
	IMessageTemplateProxy(Object obj)
protected	IMessageTemplateProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IMessageTemplateProxy

public IMessageTemplateProxy()

IMessageTemplateProxy

public IMessageTemplateProxy(Object obj)
                      throws IOException

Throws:

IOException

IMessageTemplateProxy

protected IMessageTemplateProxy(Object obj,
                                String iid)
                         throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getTemplate

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

Specified by:

getTemplate in interface IMessageTemplate

Returns:

The unformatedMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemplate

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

Specified by:

setTemplate in interface IMessageTemplate

Parameters:

unformatedMessage - The unformatedMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplateName

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

Specified by:

getTemplateName in interface IMessageTemplate

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemplateName

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

Specified by:

setTemplateName in interface IMessageTemplate

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceType

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

Specified by:

getSourceType in interface IMessageTemplate

Returns:

A com.esri.arcgis.trackinganalyst.enumTemplateSourceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceType

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

Specified by:

setSourceType in interface IMessageTemplate

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

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

Specified by:

esri_getSource in interface IMessageTemplate

Returns:

The datasetDefID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSource

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

Specified by:

setSource in interface IMessageTemplate

Parameters:

datasetDefID - The datasetDefID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

formatMessage

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

Specified by:

formatMessage in interface IMessageTemplate

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

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

Specified by:

getDateFormat in interface IMessageTemplate

Returns:

The dateFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDateFormat

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

Specified by:

setDateFormat in interface IMessageTemplate

Parameters:

dateFormat - The dateFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeFormat

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

Specified by:

getTimeFormat in interface IMessageTemplate

Returns:

The timeFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeFormat

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

Specified by:

setTimeFormat in interface IMessageTemplate

Parameters:

timeFormat - The timeFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldsWithColumns

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

Specified by:

getFieldsWithColumns in interface IMessageTemplate

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldsWithColumns

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

Specified by:

setFieldsWithColumns in interface IMessageTemplate

Parameters:

array - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.