com.esri.arcgis.trackinganalyst
Class TemplateEditorDialog

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.TemplateEditorDialog
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, ITemplateEditorDialog, ITemplateEditorDialog2, java.io.Serializable

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

COM Class 'TemplateEditorDialog'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Controls the Email Alert's template properties dialog.' 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
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.ITemplateEditorDialog2
IID, IIDf40f8e0e_bc19_40b4_b53b_839d6ab883e8, xxDummy
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.ITemplateEditorDialog
IID3ddd8dd5_564f_44bd_ba23_cc952ef399e3
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
TemplateEditorDialog()
          Constructs a TemplateEditorDialog using ArcGIS Engine.
TemplateEditorDialog(java.lang.Object obj)
          Construct a TemplateEditorDialog using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IMessageTemplate getTemplate(java.lang.String name)
          The specific message template corresponding to the specified name.
 java.lang.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 release()
          Release a TemplateEditorDialog.
 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(java.lang.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
 

Constructor Detail

TemplateEditorDialog

public TemplateEditorDialog()
                     throws java.io.IOException,
                            java.net.UnknownHostException
Constructs a TemplateEditorDialog using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

TemplateEditorDialog

public TemplateEditorDialog(java.lang.Object obj)
                     throws java.io.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:
java.io.IOException - if there are interop problems TemplateEditorDialog theTemplateEditorDialog = (TemplateEditorDialog) obj;
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a TemplateEditorDialog.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setServerConnection

public void setServerConnection(IServerConnection rhs1)
                         throws java.io.IOException,
                                AutomationException
Server connection for obtaining the service Dataset Definition ID

Specified by:
setServerConnection in interface ITemplateEditorDialog
Parameters:
rhs1 - A reference to a com.esri.arcgis.trackinganalyst.IServerConnection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAction

public void setAction(IAction rhs1)
               throws java.io.IOException,
                      AutomationException
Server or Service Action whose action's message template is to be reviewed or edited.

Specified by:
setAction in interface ITemplateEditorDialog
Parameters:
rhs1 - A reference to a com.esri.arcgis.carto.IAction (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadStorage

public void loadStorage(IStorage rootStorage)
                 throws java.io.IOException,
                        AutomationException
Load the relevant information from storage into memory.

Specified by:
loadStorage in interface ITemplateEditorDialog
Parameters:
rootStorage - A reference to a com.esri.arcgis.trackinganalyst.IStorage (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveStorage

public void saveStorage(IStorage rootStorage)
                 throws java.io.IOException,
                        AutomationException
Save the relevant information from memory into storage.

Specified by:
saveStorage in interface ITemplateEditorDialog
Parameters:
rootStorage - A reference to a com.esri.arcgis.trackinganalyst.IStorage (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showDialog

public void showDialog(java.lang.String[] selectedTemplate)
                throws java.io.IOException,
                       AutomationException
Displays the template properties dialog for review or edit.

Specified by:
showDialog in interface ITemplateEditorDialog
Parameters:
selectedTemplate - The selectedTemplate (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemplateList

public java.lang.String[] getTemplateList()
                                   throws java.io.IOException,
                                          AutomationException
List of message templates available.

Specified by:
getTemplateList in interface ITemplateEditorDialog
Returns:
The list
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemplate

public IMessageTemplate getTemplate(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException
The specific message template corresponding to the specified name.

Specified by:
getTemplate in interface ITemplateEditorDialog
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IMessageTemplate
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInsertFileButton

public void setInsertFileButton(boolean showInsertFile)
                         throws java.io.IOException,
                                AutomationException
Show the insert file button to allow browsing to a file.

Specified by:
setInsertFileButton in interface ITemplateEditorDialog2
Parameters:
showInsertFile - The showInsertFile (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInsertFileButton

public boolean isInsertFileButton()
                           throws java.io.IOException,
                                  AutomationException
Show the insert file button to allow browsing to a file.

Specified by:
isInsertFileButton in interface ITemplateEditorDialog2
Returns:
The showInsertFile
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.