com.esri.arcgis.geodatabaseextensions
Interface IDataMessage

All Superinterfaces:
Serializable
All Known Implementing Classes:
DataMessage

public interface IDataMessage
extends Serializable

Provides access to methods and properties used to manage data messages.

Product Availability

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


Method Summary
 void addArgument(Object pValue)
          Adds an argument to the data message.
 void addColumn(Object pValue)
          Adds a column to the data message.
 Object getArgument(int nIndex)
          Gets an argument for the data message.
 int getArgumentCount()
          Number of arguments in the data message.
 Object getColumn(int nIndex)
          Returns value for columns in the data message.
 int getColumnCount()
          Number of columns in data message.
 Object getCreationDate()
          Indicates date of data message's creation.
 String getDataDefinitionID()
          ID value for the data definition in the message.
 String getDestination()
          Indicates destination of the data message.
 String getID()
          ID value for the data message.
 int getMessageType()
          Indicates type of data message.
 int getPriority()
          Indictes priority of data message.
 Object getRawColumn(int nIndex)
          Returns the Raw column info.
 void removeArgument(int nIndex)
          Removes an argument from the data message.
 void removeColumn(int nIndex)
          Removes a column from the data message.
 void setArgument(int nIndex, Object pValue)
          Sets an argument for the data message.
 void setColumn(int nIndex, Object pValue)
          Sets the number of columns in a data message.
 void setDataDefinitionID(String pVal)
          ID value for the data definition in the message.
 void setDestination(String pVal)
          Indicates destination of the data message.
 void setPriority(int pVal)
          Indictes priority of data message.
 

Method Detail

getCreationDate

Object getCreationDate()
                       throws IOException,
                              AutomationException
Indicates date of data message's creation.

Product Availability

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

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getID

String getID()
             throws IOException,
                    AutomationException
ID value for the data message.

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessageType

int getMessageType()
                   throws IOException,
                          AutomationException
Indicates type of data message.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabaseextensions.enumMessageType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriority

int getPriority()
                throws IOException,
                       AutomationException
Indictes priority of data message.

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPriority

void setPriority(int pVal)
                 throws IOException,
                        AutomationException
Indictes priority of data message.

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDestination

String getDestination()
                      throws IOException,
                             AutomationException
Indicates destination of the data message.

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDestination

void setDestination(String pVal)
                    throws IOException,
                           AutomationException
Indicates destination of the data message.

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getArgumentCount

int getArgumentCount()
                     throws IOException,
                            AutomationException
Number of arguments in the data message.

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setArgument

void setArgument(int nIndex,
                 Object pValue)
                 throws IOException,
                        AutomationException
Sets an argument for the data message.

Product Availability

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

Parameters:
nIndex - The nIndex (in)
pValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addArgument

void addArgument(Object pValue)
                 throws IOException,
                        AutomationException
Adds an argument to the data message.

Product Availability

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

Parameters:
pValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeArgument

void removeArgument(int nIndex)
                    throws IOException,
                           AutomationException
Removes an argument from the data message.

Product Availability

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

Parameters:
nIndex - The nIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getArgument

Object getArgument(int nIndex)
                   throws IOException,
                          AutomationException
Gets an argument for the data message.

Product Availability

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

Parameters:
nIndex - The nIndex (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataDefinitionID

String getDataDefinitionID()
                           throws IOException,
                                  AutomationException
ID value for the data definition in the message.

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataDefinitionID

void setDataDefinitionID(String pVal)
                         throws IOException,
                                AutomationException
ID value for the data definition in the message.

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColumnCount

int getColumnCount()
                   throws IOException,
                          AutomationException
Number of columns in data message.

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColumn

void setColumn(int nIndex,
               Object pValue)
               throws IOException,
                      AutomationException
Sets the number of columns in a data message.

Product Availability

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

Parameters:
nIndex - The nIndex (in)
pValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addColumn

void addColumn(Object pValue)
               throws IOException,
                      AutomationException
Adds a column to the data message.

Product Availability

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

Parameters:
pValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeColumn

void removeColumn(int nIndex)
                  throws IOException,
                         AutomationException
Removes a column from the data message.

Product Availability

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

Parameters:
nIndex - The nIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColumn

Object getColumn(int nIndex)
                 throws IOException,
                        AutomationException
Returns value for columns in the data message.

Product Availability

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

Parameters:
nIndex - The nIndex (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRawColumn

Object getRawColumn(int nIndex)
                    throws IOException,
                           AutomationException
Returns the Raw column info. For Objects it is a array of bytes conforming to the IPersist Stream format.

Product Availability

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

Parameters:
nIndex - The nIndex (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.