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

All Superinterfaces:
TResponseContent
All Known Implementing Classes:
TResponseInfoContentImpl

public interface TResponseInfoContent
extends TResponseContent

TResponseInfoContent represents the interface for Tamino XML document response informations. This mainly comprises the information contained within the result documents that are handed back from Tamino due to specific request. Furthermore all header field specific key/value pairs can be querried in a generic way by requesting the relevant collections.

Version:
$Revision: 1.8 $
Author:
Marcus Schreyer

Method Summary
 void clear()
          Clears the entire information content that is up to the current time given.
 java.util.Collection getHeaderFieldKeys()
          Gets all keys for the header contained within the response message obtained from Tamino.
 java.lang.String getHeaderFieldValue(java.lang.String key)
          Gets a specific header value for the specified header key.
 TResponseContentItem getItem(int index, java.lang.String specifier)
          Gets the TResponseInfoItem instance that matches the given specifier with the given index.
 int getItemSize(java.lang.String specifier)
          Returns the number of response content items that have been put into the info content for the given specifier.
 boolean hasItem(java.lang.String specifier)
          Indicates if a TResponseInfoItem given by the specifier is contained within the response info instance.
 void putItem(java.lang.String specifier, TResponseContentItem responseContentItem)
          Puts the given TResponseContentItem with the given specifier to this info content.
 void setHeader(TStreamHeader header)
          Sets a new header represented by the given TStreamHeader instance.
 

Method Detail

setHeader

void setHeader(TStreamHeader header)
Sets a new header represented by the given TStreamHeader instance.

Parameters:
header - the new headers.

getHeaderFieldKeys

java.util.Collection getHeaderFieldKeys()
Gets all keys for the header contained within the response message obtained from Tamino.

Returns:
Collection with the header field keys.

getHeaderFieldValue

java.lang.String getHeaderFieldValue(java.lang.String key)
Gets a specific header value for the specified header key. If none is given null is returned.

Returns:
The header field value for the specified key.

putItem

void putItem(java.lang.String specifier,
             TResponseContentItem responseContentItem)
Puts the given TResponseContentItem with the given specifier to this info content. If this one is already given nothing happens.

Parameters:
specifier - specifies the concrete result state item.
responseContentItem - is the item to be inserted.

getItem

TResponseContentItem getItem(int index,
                             java.lang.String specifier)
Gets the TResponseInfoItem instance that matches the given specifier with the given index. If it is not given, null is returned.

Returns:
The response content item instance if given, null otherwise.

getItemSize

int getItemSize(java.lang.String specifier)
Returns the number of response content items that have been put into the info content for the given specifier.

Parameters:
specifier - identifies the specific content item for which the capacity is requested.
Returns:
the number of given content items if existant, 0 otherwise.

clear

void clear()
Clears the entire information content that is up to the current time given.


hasItem

boolean hasItem(java.lang.String specifier)
Indicates if a TResponseInfoItem given by the specifier is contained within the response info instance.

Returns:
true if the specified item exists, false otherwise.


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