: Class RealMessage (RealSQL-JDBC)

External Interfaces > Reality Java Interface > JavaDocs > JavaDocs for Reality SQL/JDBC Classes > RealMessage

Documentation Comments

Use this form to comment on this topic. You can also provide any general observations about the Online Documentation, or request that additional information be added in a future release.

Reality V15.0 ()

: Class RealMessage (RealSQL-JDBC) (realmessage.html)

To	Reality
Version
Topic
Submitted by
Company
Location
Email address
Comment

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.northgateis.reality.realsql
Class RealMessage

java.lang.Object
 |
 +--com.northgateis.reality.realsql.RealMessage

public class RealMessage
extends java.lang.Object

Wrapper class for the DDAMsg object generated when receiving data from the Reality Server.

Constructor Summary
`RealMessage(com.northgateis.comms.dda.DDAMsg msg)` Initialises a new RealMessage object.

Method Summary
`protected int`	`getAccessPlan()` Get the AccessPlan for this particular message.
`protected byte[]`	`getData(int value)` Get the data buffer for the last operation performed on the Reality Server.
`protected int`	`getNumAttributes()` Get the number of attributes for this particular message.
`protected int`	`getRowCount()` Get the number of rows affected by a previous update statement.
`protected int`	`getServerCode()` Get the server code for the last operation performed on the Reality Server.
`protected java.lang.String`	`getServerMessage()` Get the server message for the last operation performed on the Reality Server, if one exists.
`protected int`	`result()` Get result code of the last operation performed on the Reality Server.

Methods inherited from class java.lang.Object

clone, 
equals, 
finalize, 
getClass, 
hashCode, 
notify, 
notifyAll, 
toString, 
wait, 
wait, 
wait

Constructor Detail

RealMessage

public RealMessage(com.northgateis.comms.dda.DDAMsg msg)
 throws RealSQLException

Initialises a new RealMessage object.

Parameters:: msg - DDAMsg object.
Throws:: RealSQLException -

Method Detail

result

protected int result()
 throws RealSQLException

Get result code of the last operation performed on the Reality Server.

This maybe one of the following codes:



   SQL_SUCCESS

   SQL_SUCCESS_WITH_INFO

   SQL_ERROR

   SQL_NO_DATA_FOUND

Returns:: return code from server.
Throws:: RealSQLException -

getServerCode

protected int getServerCode()
 throws RealSQLException

Get the server code for the last operation performed on the Reality Server.

This is normally only set if the last operation returned SQL_ERROR

Returns:: server code.
Throws:: RealSQLException -

getServerMessage

protected java.lang.String getServerMessage()
 throws RealSQLException

Get the server message for the last operation performed on the Reality Server, if one exists.

This is normally only set if the last operation returned SQL_ERROR

Returns:: server message.
Throws:: RealSQLException -

getData

protected byte[] getData(int value)

Get the data buffer for the last operation performed on the Reality Server.

if value is zero then the complete data buffer is returned, if value is greater than zero then that AM delimited segment is returned.

Parameters:: value - segment to be returned.
Returns:: byte array.

getAccessPlan

protected int getAccessPlan()

Get the AccessPlan for this particular message.

Returns:: accessPlan.

getRowCount

protected int getRowCount()

Get the number of rows affected by a previous update statement.

Returns:: number of rows.

getNumAttributes

protected int getNumAttributes()

Get the number of attributes for this particular message.

The default attribute delimiter is a Reality Attribute Mark (AM).

Returns:: number of attributes.