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, java.io.Serializable

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

COM Class 'Message'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriSystem.olb'

Description 'A serializable object that represents a request or response 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 =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.system.IMessage
IID, IIDe4e5591d_c47e_4a2d_856e_8a1847547a97, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
Message()
          Constructs a Message using ArcGIS Engine.
Message(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Message theMessage = (Message) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
static java.lang.String getClsid()
          getClsid.
 IErrorInfo getErrorInfo()
          Valid when the message is a fault.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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.
 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 release()
          Release 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Message

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

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

Message

public Message(java.lang.Object obj)
        throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a Message.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of the message.

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

setName

public void setName(java.lang.String messageName)
             throws java.io.IOException,
                    AutomationException
Name of the message.

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

getNamespaceURI

public java.lang.String getNamespaceURI()
                                 throws java.io.IOException,
                                        AutomationException
Namespace of the message.

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

setNamespaceURI

public void setNamespaceURI(java.lang.String uri)
                     throws java.io.IOException,
                            AutomationException
Namespace of the message.

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

getParameters

public IXMLSerializeData getParameters()
                                throws java.io.IOException,
                                       AutomationException
Parameters of the message.

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

public IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException
Properties of the message.

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

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

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

public int getResult()
              throws java.io.IOException,
                     AutomationException
HRESULT of the Message.

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

getErrorInfo

public IErrorInfo getErrorInfo()
                        throws java.io.IOException,
                               AutomationException
Valid when the message is a fault.

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

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

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

public void readXML(IStream stream)
             throws java.io.IOException,
                    AutomationException
Reads an XML input stream for a message.

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

public void writeXML(IStream stream)
              throws java.io.IOException,
                     AutomationException
Writes an XML output stream for a message.

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.