com.esri.arcgis.trackinganalyst
Class RecipientContainer

java.lang.Object
  com.esri.arcgis.trackinganalyst.RecipientContainer

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IRecipientContainer, Serializable

public class RecipientContainer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRecipientContainer, ISupportErrorInfo

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

See Also:

Serialized Form

Constructor Summary

RecipientContainer()
Constructs a RecipientContainer using ArcGIS Engine.

RecipientContainer(Object obj)
Construct a RecipientContainer using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addName(String pbstrName) Adds an email address to the recipient container.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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.

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

RecipientContainer

public RecipientContainer()
                   throws IOException,
                          UnknownHostException

Constructs a RecipientContainer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RecipientContainer

public RecipientContainer(Object obj)
                   throws IOException

Construct a RecipientContainer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RecipientContainer.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems RecipientContainer theRecipientContainer = (RecipientContainer) 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

loadStorage

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

Specified by:

loadStorage in interface IRecipientContainer

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

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

Specified by:

saveStorage in interface IRecipientContainer

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

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

Specified by:

getCount in interface IRecipientContainer

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addName

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

Specified by:

addName in interface IRecipientContainer

Parameters:

pbstrName - The pbstrName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

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

Specified by:

getName in interface IRecipientContainer

Parameters:

nIndex - The nIndex (in)

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.