com.esri.arcgis.system
Class Message

java.lang.Object
  extended by com.esri.arcgis.system.Message
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IMessage, ISupportErrorInfo, Serializable

public class Message
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMessage, ISupportErrorInfo

A serializable object that represents a request or response message

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
Message()
          Constructs a Message using ArcGIS Engine.
Message(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Message theMessage = (Message) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 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.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void readXML(IStream stream)
          Reads an XML input stream for a message.
 void setError(int hresult, IErrorInfo pErrorInfo)
          Sets 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.
 
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

Message

public Message()
        throws IOException,
               UnknownHostException
Constructs a Message using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

Message

public Message(Object obj)
        throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Message theMessage = (Message) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
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

getName

public 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

Specified by:
getName in interface IMessage
Returns:
The messageName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public 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

Specified by:
setName in interface IMessage
Parameters:
messageName - The messageName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNamespaceURI

public 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

Specified by:
getNamespaceURI in interface IMessage
Returns:
The uri
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNamespaceURI

public 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

Specified by:
setNamespaceURI in interface IMessage
Parameters:
uri - The uri (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameters

public 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

Specified by:
getParameters in interface IMessage
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

public 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

Specified by:
getProperties in interface IMessage
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

public void setPropertiesByRef(IPropertySet props)
                        throws IOException,
                               AutomationException
Properties of the message.

Product Availability

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

Specified by:
setPropertiesByRef in interface IMessage
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

public 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

Specified by:
getResult in interface IMessage
Returns:
The hresult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getErrorInfo

public 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

Specified by:
getErrorInfo in interface IMessage
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

public void setError(int hresult,
                     IErrorInfo pErrorInfo)
              throws IOException,
                     AutomationException
Sets error information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setError in interface IMessage
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

public 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

Specified by:
readXML in interface IMessage
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

public 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

Specified by:
writeXML in interface IMessage
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.

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.