com.esri.arcgis.trackinganalyst
Class TemplateEditorDialog

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, ITemplateEditorDialog, ITemplateEditorDialog2, Serializable

public class TemplateEditorDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemplateEditorDialog, ITemplateEditorDialog2, ISupportErrorInfo

Controls the Email Alert's template properties dialog.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

TemplateEditorDialog()
Constructs a TemplateEditorDialog using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IMessageTemplate	getTemplate(String name) The specific message template corresponding to the specified name.
String[]	getTemplateList() List of message templates available.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isInsertFileButton() Show the insert file button to allow browsing to a file.
void	loadStorage(IStorage rootStorage) Load the relevant information from storage into memory.
void	saveStorage(IStorage rootStorage) Save the relevant information from memory into storage.
void	setAction(IAction rhs1) Server or Service Action whose action's message template is to be reviewed or edited.
void	setInsertFileButton(boolean showInsertFile) Show the insert file button to allow browsing to a file.
void	setServerConnection(IServerConnection rhs1) Server connection for obtaining the service Dataset Definition ID
void	showDialog(String[] selectedTemplate) Displays the template properties dialog for review or edit.

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

TemplateEditorDialog

public TemplateEditorDialog()
                     throws IOException,
                            UnknownHostException

Constructs a TemplateEditorDialog using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TemplateEditorDialog

public TemplateEditorDialog(Object obj)
                     throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems TemplateEditorDialog theTemplateEditorDialog = (TemplateEditorDialog) 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

setServerConnection

public void setServerConnection(IServerConnection rhs1)
                         throws IOException,
                                AutomationException

Server connection for obtaining the service Dataset Definition ID

Product Availability

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

Specified by:

setServerConnection in interface ITemplateEditorDialog

Parameters:

rhs1 - A reference to a com.esri.arcgis.trackinganalyst.IServerConnection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAction

public void setAction(IAction rhs1)
               throws IOException,
                      AutomationException

Server or Service Action whose action's message template is to be reviewed or edited.

Product Availability

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

Specified by:

setAction in interface ITemplateEditorDialog

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IAction (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadStorage

public void loadStorage(IStorage rootStorage)
                 throws IOException,
                        AutomationException

Load the relevant information from storage into memory.

Product Availability

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

Specified by:

loadStorage in interface ITemplateEditorDialog

Parameters:

rootStorage - A reference to a com.esri.arcgis.trackinganalyst.IStorage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveStorage

public void saveStorage(IStorage rootStorage)
                 throws IOException,
                        AutomationException

Save the relevant information from memory into storage.

Product Availability

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

Specified by:

saveStorage in interface ITemplateEditorDialog

Parameters:

rootStorage - A reference to a com.esri.arcgis.trackinganalyst.IStorage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showDialog

public void showDialog(String[] selectedTemplate)
                throws IOException,
                       AutomationException

Displays the template properties dialog for review or edit.

Product Availability

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

Specified by:

showDialog in interface ITemplateEditorDialog

Parameters:

selectedTemplate - The selectedTemplate (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplateList

public String[] getTemplateList()
                         throws IOException,
                                AutomationException

List of message templates available.

Product Availability

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

Specified by:

getTemplateList in interface ITemplateEditorDialog

Returns:

The list

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplate

public IMessageTemplate getTemplate(String name)
                             throws IOException,
                                    AutomationException

The specific message template corresponding to the specified name.

Product Availability

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

Specified by:

getTemplate in interface ITemplateEditorDialog

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IMessageTemplate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInsertFileButton

public void setInsertFileButton(boolean showInsertFile)
                         throws IOException,
                                AutomationException

Show the insert file button to allow browsing to a file.

Product Availability

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

Specified by:

setInsertFileButton in interface ITemplateEditorDialog2

Parameters:

showInsertFile - The showInsertFile (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInsertFileButton

public boolean isInsertFileButton()
                           throws IOException,
                                  AutomationException

Show the insert file button to allow browsing to a file.

Product Availability

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

Specified by:

isInsertFileButton in interface ITemplateEditorDialog2

Returns:

The showInsertFile

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.