com.softwareag.tamino.db.api.common
Interface TAccessFailureMessage

All Known Implementing Classes:
TAccessFailureException

public interface TAccessFailureMessage

TAccessFailureMessage represents a message that contains all the information provided by Tamino in case a specific access operation fails. This includes the return value, error code, message text and the message line. Each of these properties can be obtained by the appropiate access method.

Version:
$Revision: 1.5 $
Author:
Marcus Schreyer

Method Summary
 java.lang.String getCode()
          Gets the error code.
 java.lang.String getMessageLine()
          Gets the message line.
 java.lang.String getMessageText()
          Gets the message text.
 java.lang.String getReturnValue()
          Gets the return value.
 boolean matchesReturnValue(java.lang.String returnValue)
          Indicates if the access failure message matches the given return value.
 boolean matchesReturnValue(java.lang.String startValue, java.lang.String endValue)
          Indicates if the access failure message matches a return value that lies in between the specified return value range including the startValue and the endValue.
 

Method Detail

getReturnValue

java.lang.String getReturnValue()
Gets the return value.

Returns:
the return value

getCode

java.lang.String getCode()
Gets the error code.

Returns:
the error code.

getMessageText

java.lang.String getMessageText()
Gets the message text.

Returns:
the message text.

getMessageLine

java.lang.String getMessageLine()
Gets the message line.

Returns:
the message line.

matchesReturnValue

boolean matchesReturnValue(java.lang.String returnValue)
Indicates if the access failure message matches the given return value.

Parameters:
the - returnValue to match
Returns:
true if this.getReturnValue().equals( returnValue )

matchesReturnValue

boolean matchesReturnValue(java.lang.String startValue,
                           java.lang.String endValue)
Indicates if the access failure message matches a return value that lies in between the specified return value range including the startValue and the endValue.

Parameters:
startValue - the start for the return value range.
endValue - the end of the return value range.
Returns:
true if returnValue >= startValue and returnValue <= endValue else false.


Copyright (c) 2013 Software AG. All Rights Reserved.