com.esri.arcgis.trackinganalyst
Class MessageTemplate

java.lang.Object
  com.esri.arcgis.trackinganalyst.MessageTemplate

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IMessageTemplate, Externalizable, Serializable

public class MessageTemplate
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMessageTemplate, IPersistStream, IPersist, IClone, ISupportErrorInfo, IDocumentVersionSupportGEN, Externalizable

Controls the 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.

See Also:

Serialized Form

Constructor Summary

MessageTemplate()
Constructs a MessageTemplate using ArcGIS Engine.

MessageTemplate(Object obj)
Construct a MessageTemplate using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
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.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
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.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

MessageTemplate

public MessageTemplate()
                throws IOException,
                       UnknownHostException

Constructs a MessageTemplate using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MessageTemplate

public MessageTemplate(Object obj)
                throws IOException

Construct a MessageTemplate using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MessageTemplate.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems MessageTemplate theMessageTemplate = (MessageTemplate) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

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.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException