com.esri.arcgis.trackinganalyst
Interface IEmailAlertAction

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

EmailAlertAction, IEmailAlertActionProxy

public interface IEmailAlertAction
extends java.io.Serializable

COM Interface 'IEmailAlertAction'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to properties and methods needed for the Email Alert actions.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID135214fc_6f2c_4b50_9903_85b8759f6804
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getDatasetDefinitionID() Dataset Definition ID associated with the service connection to the real-time temporal events.
java.lang.String[]	getEmailList() List of email addresses for the recipients of the action's Email Alert.
IEmailProperties	getEmailSetupProperties() Property set holding the SMTPServer and domain name to be used to construct the sender email address for the Email Alert messages.
IMessageTemplate	getMessageTemplate() Template for use when constructing the action's Email Alert message body.
void	setDatasetDefinitionID(java.lang.String pVal) Dataset Definition ID associated with the service connection to the real-time temporal events.
void	setEmailList(java.lang.String[] pVal) List of email addresses for the recipients of the action's Email Alert.
void	setEmailSetupProperties(IEmailProperties ppVal) Property set holding the SMTPServer and domain name to be used to construct the sender email address for the Email Alert messages.
void	setMessageTemplate(IMessageTemplate pVal) Template for use when constructing the action's Email Alert message body.

Field Detail

IID135214fc_6f2c_4b50_9903_85b8759f6804

static final int IID135214fc_6f2c_4b50_9903_85b8759f6804

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getMessageTemplate

IMessageTemplate getMessageTemplate()
                                    throws java.io.IOException,
                                           AutomationException

Template for use when constructing the action's Email Alert message body.

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.

setMessageTemplate

void setMessageTemplate(IMessageTemplate pVal)
                        throws java.io.IOException,
                               AutomationException

Template for use when constructing the action's Email Alert message body.

Parameters:

pVal - A reference to a com.esri.arcgis.trackinganalyst.IMessageTemplate (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEmailList

java.lang.String[] getEmailList()
                                throws java.io.IOException,
                                       AutomationException

List of email addresses for the recipients of the action's Email Alert.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmailList

void setEmailList(java.lang.String[] pVal)
                  throws java.io.IOException,
                         AutomationException

List of email addresses for the recipients of the action's Email Alert.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEmailSetupProperties

IEmailProperties getEmailSetupProperties()
                                         throws java.io.IOException,
                                                AutomationException

Property set holding the SMTPServer and domain name to be used to construct the sender email address for the Email Alert messages.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmailSetupProperties

void setEmailSetupProperties(IEmailProperties ppVal)
                             throws java.io.IOException,
                                    AutomationException

Property set holding the SMTPServer and domain name to be used to construct the sender email address for the Email Alert messages.

Parameters:

ppVal - A reference to a com.esri.arcgis.trackinganalyst.IEmailProperties (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetDefinitionID

java.lang.String getDatasetDefinitionID()
                                        throws java.io.IOException,
                                               AutomationException

Dataset Definition ID associated with the service connection to the real-time temporal events.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetDefinitionID

void setDatasetDefinitionID(java.lang.String pVal)
                            throws java.io.IOException,
                                   AutomationException

Dataset Definition ID associated with the service connection to the real-time temporal events.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.