com.esri.arcgis.system
Interface IMessage

All Superinterfaces:

Serializable

All Known Implementing Classes:

Message

public interface IMessage
extends Serializable

Provides access to members that control the properties of a Message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

IErrorInfo	getErrorInfo() Valid when the message is a fault.
String	getName() Name of the message.
String	getNamespaceURI() Namespace of the message.
IXMLSerializeData	getParameters() Parameters of the message.
IPropertySet	getProperties() Properties of the message.
int	getResult() HRESULT of the Message.
void	readXML(IStream stream) Reads an XML input stream for a message.
void	setError(int hresult, IErrorInfo pErrorInfo) Writes error information.
void	setName(String messageName) Name of the message.
void	setNamespaceURI(String uri) Namespace of the message.
void	setPropertiesByRef(IPropertySet props) Properties of the message.
void	writeXML(IStream stream) Writes an XML output stream for a message.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The messageName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String messageName)
             throws IOException,
                    AutomationException

Name of the message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

messageName - The messageName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNamespaceURI

String getNamespaceURI()
                       throws IOException,
                              AutomationException

Namespace of the message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The uri

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNamespaceURI

void setNamespaceURI(String uri)
                     throws IOException,
                            AutomationException

Namespace of the message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

uri - The uri (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

IXMLSerializeData getParameters()
                                throws IOException,
                                       AutomationException

Parameters of the message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.IXMLSerializeData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

Properties of the message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertiesByRef

void setPropertiesByRef(IPropertySet props)
                        throws IOException,
                               AutomationException

Properties of the message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

props - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResult

int getResult()
              throws IOException,
                     AutomationException

HRESULT of the Message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The hresult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getErrorInfo

IErrorInfo getErrorInfo()
                        throws IOException,
                               AutomationException

Valid when the message is a fault.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.IErrorInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setError

void setError(int hresult,
              IErrorInfo pErrorInfo)
              throws IOException,
                     AutomationException

Writes error information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

hresult - The hresult (in)

pErrorInfo - A reference to a com.esri.arcgis.system.IErrorInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readXML

void readXML(IStream stream)
             throws IOException,
                    AutomationException

Reads an XML input stream for a message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

stream - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeXML

void writeXML(IStream stream)
              throws IOException,
                     AutomationException

Writes an XML output stream for a message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

stream - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.