com.ssaglobal.bde
Interface IBdeMessage

public interface IBdeMessage

The IBdeMessage interface enables accessing the error and warning structure. An instance of IBdeMessage can be retrieved using the BdeResultException.getBdeMessage() method.
The errors and warnings which can be retreived using the BdeManager also exist of IBdeMessages.

Method Summary

java.lang.String	getMessageAdditionalHelpText() This (optional) string contains more information on the message.
java.lang.String	getMessageAdditionalHelpURI() This (optional) string contains a reference to a website containing more information on the message Either this value is availbale or this information can direcly be retreived using getMessageAdditionalHelpText()
java.lang.String	getMessageCode() This is the application specific code that identifies this error.
java.lang.String	getMessageCorrectiveAction() This is the (optional) description of the action that could be taken in order to correct the exception that is described by this message.
IBdeMessageDetails	getMessageDetails() An IBdeMessage contains a reference of an IBdeMessageDetails object, which describes the error on the server in detail.
java.lang.String	getMessageIndex() The (optional) Index Attribute uniquely identifies this 'sub' message.
IBdeMessageReference	getMessageReference() An IBdeMessage contains a reference of an IBdeMessageReference object, which contains information about the exact location of the error.
java.lang.String	getMessageSource() This identifies the source of the error.
java.lang.String	getMessageText() This is the description of the error.
java.lang.String	getMessageType() The messageType string specifies the type of the message, which can be: Information, Warning or Error.
boolean	hasMessageAdditionalHelpText() Indicates if the hasMessageAdditionalHelpText is present in this Message.
boolean	hasMessageAdditionalHelpURI() Indicates if the messageAdditionalHelpURI is present in this Message.
boolean	hasMessageCorrectiveAction() Indicates if the messageCorrectiveAction is present in this Message.
boolean	hasMessageDetails() Indicates if the messageDetails sub object is present in this Message.
boolean	hasMessageIndex() Indicates if the MessageIndex is present in this Message.
boolean	hasMessageReference() Indicates if the messageReference sub object is present in this Message.
java.lang.String	toString() Returns the messageText of this message complemented with the messageTexts of the Optinal 'sub' messages.

Method Detail

getMessageIndex

public java.lang.String getMessageIndex()
                                 throws BdeException

The (optional) Index Attribute uniquely identifies this 'sub' message.

Returns:

the Index.

hasMessageIndex

public boolean hasMessageIndex()

Indicates if the MessageIndex is present in this Message.

Returns:

if this message contains this value

getMessageCorrectiveAction

public java.lang.String getMessageCorrectiveAction()
                                            throws BdeException

This is the (optional) description of the action that could be taken in order to correct the exception that is described by this message.

Returns:

the Message corrective Action, if any.

hasMessageCorrectiveAction

public boolean hasMessageCorrectiveAction()

Indicates if the messageCorrectiveAction is present in this Message.

Returns:

if this message contains this value

getMessageAdditionalHelpText

public java.lang.String getMessageAdditionalHelpText()
                                              throws BdeException

This (optional) string contains more information on the message. Either this value is available or this information can indirecly be retreived using getMessageAdditionalHelpURI()

Returns:

the Additional Help Text of the message.

hasMessageAdditionalHelpText

public boolean hasMessageAdditionalHelpText()

Indicates if the hasMessageAdditionalHelpText is present in this Message.

Returns:

if this message contains this value

getMessageAdditionalHelpURI

public java.lang.String getMessageAdditionalHelpURI()
                                             throws BdeException

This (optional) string contains a reference to a website containing more information on the message Either this value is availbale or this information can direcly be retreived using getMessageAdditionalHelpText()

Returns:

the Additional Help URI of the message.

hasMessageAdditionalHelpURI

public boolean hasMessageAdditionalHelpURI()

Indicates if the messageAdditionalHelpURI is present in this Message.

Returns:

if this message contains this value

hasMessageDetails

public boolean hasMessageDetails()

Indicates if the messageDetails sub object is present in this Message.

Returns:

if this message contains this value

hasMessageReference

public boolean hasMessageReference()

Indicates if the messageReference sub object is present in this Message.

Returns:

if this message contains this value

getMessageDetails

public IBdeMessageDetails getMessageDetails()
                                     throws BdeException

An IBdeMessage contains a reference of an IBdeMessageDetails object, which describes the error on the server in detail.

Returns:

IBdeMessageDetails

getMessageReference

public IBdeMessageReference getMessageReference()
                                         throws BdeException

An IBdeMessage contains a reference of an IBdeMessageReference object, which contains information about the exact location of the error.

Returns:

IBdeMessageReference

getMessageCode

public java.lang.String getMessageCode()
                                throws BdeException

This is the application specific code that identifies this error. It is BDE specific.

Returns:

the Message Code of the message.

getMessageSource

public java.lang.String getMessageSource()
                                  throws BdeException

This identifies the source of the error.

Returns:

the source of the Message.

getMessageText

public java.lang.String getMessageText()
                                throws BdeException

This is the description of the error.

Returns:

the Message Text.

getMessageType

public java.lang.String getMessageType()
                                throws BdeException

The messageType string specifies the type of the message, which can be: Information, Warning or Error.

Returns:

the Message Type

toString

public java.lang.String toString()

Returns the messageText of this message complemented with the messageTexts of the Optinal 'sub' messages.

Overrides:

toString in class java.lang.Object

Returns:

the MessageText