com.esri.arcgis.trackinganalyst
Class IMessageTemplateProxy

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

All Implemented Interfaces:

IMessageTemplate, java.io.Externalizable, java.io.Serializable

public class IMessageTemplateProxy
extends com.esri.arcgis.interop.Dispatch
implements IMessageTemplate, java.io.Serializable

Internal use class Proxy for 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 =

See Also:

Serialized Form

Field Summary

boolean	noncastable
static java.lang.Class	targetClass

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.trackinganalyst.IMessageTemplate

IID, IIDd100dbd8_9cc2_4de1_8c26_d030e4b0f938

Constructor Summary

	IMessageTemplateProxy() For internal use only
	IMessageTemplateProxy(java.lang.Object obj)
protected	IMessageTemplateProxy(java.lang.Object obj, java.lang.String iid)
	IMessageTemplateProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IMessageTemplateProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

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

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

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

IMessageTemplateProxy

public IMessageTemplateProxy(java.lang.String CLSID,
                             java.lang.String host,
                             com.esri.arcgis.interop.AuthInfo authInfo)
                      throws java.net.UnknownHostException,
                             java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

IMessageTemplateProxy

public IMessageTemplateProxy()

For internal use only

IMessageTemplateProxy

public IMessageTemplateProxy(java.lang.Object obj)
                      throws java.io.IOException

Throws:

java.io.IOException

IMessageTemplateProxy

protected IMessageTemplateProxy(java.lang.Object obj,
                                java.lang.String iid)
                         throws java.io.IOException

Throws:

java.io.IOException

IMessageTemplateProxy

protected IMessageTemplateProxy(java.lang.String CLSID,
                                java.lang.String iid,
                                java.lang.String host,
                                com.esri.arcgis.interop.AuthInfo authInfo)
                         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

getTemplate

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

Structured message template for use as an action message output.

Specified by:

getTemplate in interface IMessageTemplate

Returns:

The unformatedMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemplate

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

Structured message template for use as an action message output.

Specified by:

setTemplate in interface IMessageTemplate

Parameters:

unformatedMessage - The unformatedMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemplateName

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

Name of a message template.

Specified by:

getTemplateName in interface IMessageTemplate

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemplateName

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

Name of a message template.

Specified by:

setTemplateName in interface IMessageTemplate

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSourceType

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

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

Specified by:

getSourceType in interface IMessageTemplate

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

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

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

Specified by:

setSourceType in interface IMessageTemplate

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

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

Dataset definition ID associated with the tracking service.

Specified by:

esri_getSource in interface IMessageTemplate

Returns:

The datasetDefID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSource

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

Dataset definition ID associated with the tracking service.

Specified by:

setSource in interface IMessageTemplate

Parameters:

datasetDefID - The datasetDefID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

formatMessage

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

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

Specified by:

formatMessage in interface IMessageTemplate

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

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

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

Specified by:

getDateFormat in interface IMessageTemplate

Returns:

The dateFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDateFormat

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

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

Specified by:

setDateFormat in interface IMessageTemplate

Parameters:

dateFormat - The dateFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeFormat

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

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

Specified by:

getTimeFormat in interface IMessageTemplate

Returns:

The timeFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeFormat

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

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

Specified by:

setTimeFormat in interface IMessageTemplate

Parameters:

timeFormat - The timeFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldsWithColumns

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

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

Specified by:

getFieldsWithColumns in interface IMessageTemplate

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldsWithColumns

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

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

Specified by:

setFieldsWithColumns in interface IMessageTemplate

Parameters:

array - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.