com.esri.arcgis.trackinganalyst
Interface IRecipientContainer

All Superinterfaces:

Serializable

All Known Implementing Classes:

IRecipientContainerProxy, RecipientContainer

public interface IRecipientContainer
extends Serializable

Provides access to properties and methods to manage the collection of email addresses of recipients of the action's Email Alerts.

Product Availability

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

Method Summary

void	addName(String pbstrName) Adds an email address to the recipient container.
int	getCount() Count of email addresses in the container.
String	getName(int nIndex) Obtains the email address from receipient container associated with the specified index.
void	loadStorage(IStorage __MIDL__IRecipientContainer0000) Load the relevant information from storage into memory.
void	saveStorage(IStorage __MIDL__IRecipientContainer0001) Save the relevant information from memory into storage.

Method Detail

loadStorage

void loadStorage(IStorage __MIDL__IRecipientContainer0000)
                 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:

__MIDL__IRecipientContainer0000 - 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 __MIDL__IRecipientContainer0001)
                 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:

__MIDL__IRecipientContainer0001 - 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.

getCount

int getCount()
             throws IOException,
                    AutomationException

Count of email addresses in the container.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addName

void addName(String pbstrName)
             throws IOException,
                    AutomationException

Adds an email address to the recipient container.

Product Availability

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

Parameters:

pbstrName - The pbstrName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName(int nIndex)
               throws IOException,
                      AutomationException

Obtains the email address from receipient container associated with the specified index.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.