com.softwareag.tamino.db.api.response
Interface TResponseHandle

All Superinterfaces:
TResponse, TResponseContent
All Known Implementing Classes:
TAbstractResponse, TResponseHandleImpl, TSerializedResponse

public interface TResponseHandle
extends TResponse

TResponseHandle is the �protected� interface for the internal (non public) access to the Tamino response object. It declares all operations needed to represent a high level Tamino response object. This comprises the access to general response message information, the result state and for query operations the access to the result set iterator. The result state encapsulates the entire set of information that is contained within a Tamino XML response document except for the querried XML documents. These can be accessed by the result set iterator which provides a way to automatically iterate over the querried set of XML documents.

Version:
$Revision: 1.8 $
Author:
Marcus Schreyer

Method Summary
 TResponseInfoContent getInfoContent()
          Gets the result state.
 java.lang.String getMessageCode()
          Gets the code attribute for the first message block with a return value not equals 0 or the empty string.
 java.lang.String getMessageLine()
          Gets the first message line for the first message block with a return value not equals 0 or the message line of the last message block.
 java.lang.String getMessageText()
          Gets the message text for the first message block with a return value not equals 0 or the empty string.
 
Methods inherited from interface com.softwareag.tamino.db.api.response.TResponse
getFirstNonXMLObject, getFirstXMLObject, getNonXMLObjectIterator, getQueryContentAsStream, getQueryContentAsString, getReturnValue, getWarnings, getXMLObjectIterator, hasFirstNonXMLObject, hasFirstXMLObject, hasQueryContent, hasWarnings
 

Method Detail

getMessageLine

java.lang.String getMessageLine()
Gets the first message line for the first message block with a return value not equals 0 or the message line of the last message block.


getMessageText

java.lang.String getMessageText()
Gets the message text for the first message block with a return value not equals 0 or the empty string.


getMessageCode

java.lang.String getMessageCode()
Gets the code attribute for the first message block with a return value not equals 0 or the empty string.


getInfoContent

TResponseInfoContent getInfoContent()
Gets the result state.

Returns:
The result state.


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