com.reuters.rc.db
Interface DbPubMsgData

All Known Implementing Classes:

AdbMInstPubMsgData

public interface DbPubMsgData

This interface abstracts the data within a message published by an ADB-like agent. It provides methods to extract the data from the message.

If a database table has the parent role in a parent-child relationship with another table and the DB publishing agents are configured to published child rows, then, when the parent table is modified, DB agent will publish the related rows from the child table(s). The child table data can be retrieved by getChildRowData method.

Author:

Jawaid Hakim., Cavit Aydin (converted to an interface)

See Also:

ChildPubMsgData

Method Summary

java.lang.String	getAgentId() Get the Agent Id.
DbChildPubMsgData[]	getChildRowData() Get all the child table data.
java.lang.String	getClassName() Get the message class - the message class is the name of the table from which the update is published.
com.tibco.tibrv.TibrvMsg	getData() Get the published data message.
DbOpcode	getOpcode() Get the message opcode.
java.lang.Long	getSequence() Get the message sequence number.
java.lang.String	getSubject() Get the message subject.
boolean	isValid() Check if the object contains a valid result set.

Method Detail

isValid

public boolean isValid()

Check if the object contains a valid result set.

Returns:

true if the object contains a valid result set. Returns false if the object does not contain a valid result set.

getData

public com.tibco.tibrv.TibrvMsg getData()

Get the published data message.

Returns:

Published data message.

getClassName

public java.lang.String getClassName()
                              throws DbSystemException

Get the message class - the message class is the name of the table from which the update is published.

Returns:

Message class name. null is returned if the class name is not formatted correctly.

getSubject

public java.lang.String getSubject()
                            throws DbBusinessException,
                                   DbSystemException

Get the message subject.

Returns:

Message subject. Returns null if subject is not found.

getSequence

public java.lang.Long getSequence()
                           throws DbBusinessException,
                                  DbSystemException

Get the message sequence number.

Returns:

Message sequence number. Returns null if sequence number is not found.

getOpcode

public DbOpcode getOpcode()
                   throws DbBusinessException,
                          DbSystemException

Get the message opcode. The opcode is the code returned by ADB.

Returns:

Message opcode.

See Also:

AdbOpcode

getAgentId

public java.lang.String getAgentId()
                            throws DbBusinessException,
                                   DbSystemException

Get the Agent Id.

Returns:

Agent id. Returns null if agent id is not found.

getChildRowData

public DbChildPubMsgData[] getChildRowData()

Get all the child table data.

See Also:

ChildPubMsgData