com.esri.arcgis.system
Interface IMessage

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BinaryMessage, IMessageProxy, Message

public interface IMessage
extends java.io.Serializable

COM Interface 'IMessage'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSystem.olb'

Description: 'Provides access to members that control the properties of a Message.' 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	IIDe4e5591d_c47e_4a2d_856e_8a1847547a97
static int	xxDummy Deprecated. Internal use only

Method Summary

IErrorInfo	getErrorInfo() Valid when the message is a fault.
java.lang.String	getName() Name of the message.
java.lang.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(java.lang.String messageName) Name of the message.
void	setNamespaceURI(java.lang.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.

Field Detail

IIDe4e5591d_c47e_4a2d_856e_8a1847547a97

static final int IIDe4e5591d_c47e_4a2d_856e_8a1847547a97

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

getName

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

Name of the message.

Returns:

The messageName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String messageName)
             throws java.io.IOException,
                    AutomationException

Name of the message.

Parameters:

messageName - The messageName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNamespaceURI

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

Namespace of the message.

Returns:

The uri

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNamespaceURI

void setNamespaceURI(java.lang.String uri)
                     throws java.io.IOException,
                            AutomationException

Namespace of the message.

Parameters:

uri - The uri (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameters

IXMLSerializeData getParameters()
                                throws java.io.IOException,
                                       AutomationException

Parameters of the message.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProperties

IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException

Properties of the message.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertiesByRef

void setPropertiesByRef(IPropertySet props)
                        throws java.io.IOException,
                               AutomationException

Properties of the message.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResult

int getResult()
              throws java.io.IOException,
                     AutomationException

HRESULT of the Message.

Returns:

The hresult

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorInfo

IErrorInfo getErrorInfo()
                        throws java.io.IOException,
                               AutomationException

Valid when the message is a fault.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setError

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

Writes error information.

Parameters:

hresult - The hresult (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readXML

void readXML(IStream stream)
             throws java.io.IOException,
                    AutomationException

Reads an XML input stream for a message.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeXML

void writeXML(IStream stream)
              throws java.io.IOException,
                     AutomationException

Writes an XML output stream for a message.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.