com.esri.arcgis.trackinganalyst
Class EmailPropertiesDialog

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.EmailPropertiesDialog
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IEmailProperties, IEmailPropertiesDialog, Serializable

public class EmailPropertiesDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IEmailPropertiesDialog, IEmailProperties, ISupportErrorInfo

Controls the Email Alert properties dialog.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
EmailPropertiesDialog()
          Constructs a EmailPropertiesDialog using ArcGIS Engine.
EmailPropertiesDialog(Object obj)
          Construct a EmailPropertiesDialog 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.
 String getFromDomain()
          property FromDomain
 String getSMTPServer()
          property SMTPServer
 String getSuggestFromUserName()
          property SuggestFromUserName
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void loadDefaults()
          Loads the Email properties dialog with the current set of properties.
 void setAction(IAction rhs1)
          Action whose Email properties are to be reviewed or edited.
 void setFromDomain(String pVal)
          property FromDomain
 void setSMTPServer(String pVal)
          property SMTPServer
 void showDialog(boolean bUseDefaults)
          Displays the Email 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

EmailPropertiesDialog

public EmailPropertiesDialog()
                      throws IOException,
                             UnknownHostException
Constructs a EmailPropertiesDialog using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

EmailPropertiesDialog

public EmailPropertiesDialog(Object obj)
                      throws IOException
Construct a EmailPropertiesDialog using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to EmailPropertiesDialog.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems EmailPropertiesDialog theEmailPropertiesDialog = (EmailPropertiesDialog) 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

setAction

public void setAction(IAction rhs1)
               throws IOException,
                      AutomationException
Action whose Email properties are 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 IEmailPropertiesDialog
Parameters:
rhs1 - A reference to a com.esri.arcgis.trackinganalyst.IAction (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showDialog

public void showDialog(boolean bUseDefaults)
                throws IOException,
                       AutomationException
Displays the Email 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 IEmailPropertiesDialog
Parameters:
bUseDefaults - The bUseDefaults (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadDefaults

public void loadDefaults()
                  throws IOException,
                         AutomationException
Loads the Email properties dialog with the current set of properties.

Product Availability

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

Specified by:
loadDefaults in interface IEmailPropertiesDialog
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSMTPServer

public String getSMTPServer()
                     throws IOException,
                            AutomationException
property SMTPServer

Product Availability

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

Specified by:
getSMTPServer in interface IEmailProperties
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSMTPServer

public void setSMTPServer(String pVal)
                   throws IOException,
                          AutomationException
property SMTPServer

Product Availability

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

Specified by:
setSMTPServer in interface IEmailProperties
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFromDomain

public String getFromDomain()
                     throws IOException,
                            AutomationException
property FromDomain

Product Availability

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

Specified by:
getFromDomain in interface IEmailProperties
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFromDomain

public void setFromDomain(String pVal)
                   throws IOException,
                          AutomationException
property FromDomain

Product Availability

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

Specified by:
setFromDomain in interface IEmailProperties
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSuggestFromUserName

public String getSuggestFromUserName()
                              throws IOException,
                                     AutomationException
property SuggestFromUserName

Product Availability

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

Specified by:
getSuggestFromUserName in interface IEmailProperties
Returns:
The pVal
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.