com.esri.arcgis.geodatabaseextensions

Interface IDataMessage

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IDataMessageProxy

public interface IDataMessage
extends java.io.Serializable

COM Interface 'IDataMessage'. Generated 9/21/2023 10:01:49 AM from 'X:\ArcGIS\com\server\esriGeoDatabaseExtensions.tlb'

Description: 'Provides access to methods and properties used to manage data messages.' 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

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDcc018a04_24fb_11d4_b34c_00104ba2abcc
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	addArgument(java.lang.Object pValue) Adds an argument to the data message.
void	addColumn(java.lang.Object pValue) Adds a column to the data message.
java.lang.Object	getArgument(int nIndex) Gets an argument for the data message.
int	getArgumentCount() Number of arguments in the data message.
java.lang.Object	getColumn(int nIndex) Returns value for columns in the data message.
int	getColumnCount() Number of columns in data message.
java.lang.Object	getCreationDate() Indicates date of data message's creation.
java.lang.String	getDataDefinitionID() ID value for the data definition in the message.
java.lang.String	getDestination() Indicates destination of the data message.
java.lang.String	getID() ID value for the data message.
int	getMessageType() Indicates type of data message.
int	getPriority() Indictes priority of data message.
java.lang.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, java.lang.Object pValue) Sets an argument for the data message.
void	setColumn(int nIndex, java.lang.Object pValue) Sets the number of columns in a data message.
void	setDataDefinitionID(java.lang.String pVal) ID value for the data definition in the message.
void	setDestination(java.lang.String pVal) Indicates destination of the data message.
void	setPriority(int pVal) Indictes priority of data message.

Field Detail

IIDcc018a04_24fb_11d4_b34c_00104ba2abcc

static final int IIDcc018a04_24fb_11d4_b34c_00104ba2abcc

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

getCreationDate

java.lang.Object getCreationDate()
                          throws java.io.IOException,
                                 AutomationException

Indicates date of data message's creation.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

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

ID value for the data message.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessageType

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

Indicates type of data message.

Returns:

A com.esri.arcgis.geodatabaseextensions.enumMessageType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPriority

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

Indictes priority of data message.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPriority

void setPriority(int pVal)
          throws java.io.IOException,
                 AutomationException

Indictes priority of data message.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDestination

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

Indicates destination of the data message.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDestination

void setDestination(java.lang.String pVal)
             throws java.io.IOException,
                    AutomationException

Indicates destination of the data message.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getArgumentCount

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

Number of arguments in the data message.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setArgument

void setArgument(int nIndex,
                 java.lang.Object pValue)
          throws java.io.IOException,
                 AutomationException

Sets an argument for the data message.

Parameters:

nIndex - The nIndex (in)

pValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addArgument

void addArgument(java.lang.Object pValue)
          throws java.io.IOException,
                 AutomationException

Adds an argument to the data message.

Parameters:

pValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeArgument

void removeArgument(int nIndex)
             throws java.io.IOException,
                    AutomationException

Removes an argument from the data message.

Parameters:

nIndex - The nIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getArgument

java.lang.Object getArgument(int nIndex)
                      throws java.io.IOException,
                             AutomationException

Gets an argument for the data message.

Parameters:

nIndex - The nIndex (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataDefinitionID

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

ID value for the data definition in the message.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataDefinitionID

void setDataDefinitionID(java.lang.String pVal)
                  throws java.io.IOException,
                         AutomationException

ID value for the data definition in the message.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnCount

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

Number of columns in data message.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColumn

void setColumn(int nIndex,
               java.lang.Object pValue)
        throws java.io.IOException,
               AutomationException

Sets the number of columns in a data message.

Parameters:

nIndex - The nIndex (in)

pValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addColumn

void addColumn(java.lang.Object pValue)
        throws java.io.IOException,
               AutomationException

Adds a column to the data message.

Parameters:

pValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeColumn

void removeColumn(int nIndex)
           throws java.io.IOException,
                  AutomationException

Removes a column from the data message.

Parameters:

nIndex - The nIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumn

java.lang.Object getColumn(int nIndex)
                    throws java.io.IOException,
                           AutomationException

Returns value for columns in the data message.

Parameters:

nIndex - The nIndex (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRawColumn

java.lang.Object getRawColumn(int nIndex)
                       throws java.io.IOException,
                              AutomationException

Returns the Raw column info. For Objects it is a array of bytes conforming to the IPersist Stream format.

Parameters:

nIndex - The nIndex (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.