com.esri.arcgis.trackinganalyst
Interface ITemplateEditorDialog

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITemplateEditorDialog2

All Known Implementing Classes:

ITemplateEditorDialogProxy, TemplateEditorDialog

public interface ITemplateEditorDialog
extends Serializable

Provides the dialog to access and edit message templates used for message bodies for actions.

Product Availability

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

Method Summary

IMessageTemplate	getTemplate(String name) The specific message template corresponding to the specified name.
String[]	getTemplateList() List of message templates available.
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	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.

Method Detail

setServerConnection

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.

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

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.

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

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.

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

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.

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

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.

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

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.

Returns:

The list

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplate

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.

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.