org.eclipse.ohf.bridge.type
Class QueryDocumentsResponseType

java.lang.Object
  org.eclipse.ohf.bridge.type.ResponseType
      org.eclipse.ohf.bridge.type.QueryDocumentsResponseType

All Implemented Interfaces:

java.io.Serializable

public class QueryDocumentsResponseType
extends ResponseType

Contains the list of document metadata returned from an XDS query.

See Also:

Serialized Form

Constructor Summary

QueryDocumentsResponseType()
The constructor assumes that documents will arrive or that the set is empty.

Method Summary

XDSDocType[]	getDocumentTypeArray() This method returns the document array which holds the documents retrieved
void	setDocumentTypeArray(XDSDocType[] documentTypeArray) This method sets the array of documents that are held in this collection
java.lang.String	toString() Constructs a String with all attributes in name = value format.

Methods inherited from class org.eclipse.ohf.bridge.type.ResponseType

getFailMessage, getLog, getSessionID, getSuccessMessage, isSuccess, setFailMessage, setLog, setSessionID, setSuccess, setSuccessMessage, successSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryDocumentsResponseType

public QueryDocumentsResponseType()

The constructor assumes that documents will arrive or that the set is empty. Either way, it makes sure that a null pointer doesn't get sent back to the web application, and let's the web application deal with the empty array

Method Detail

getDocumentTypeArray

public XDSDocType[] getDocumentTypeArray()

This method returns the document array which holds the documents retrieved

Returns:

Gets the document array populated with the retrieved documents

setDocumentTypeArray

public void setDocumentTypeArray(XDSDocType[] documentTypeArray)

This method sets the array of documents that are held in this collection

Parameters:

documentTypeArray - The array of documents that this collection will hold

toString

public java.lang.String toString()

Constructs a String with all attributes in name = value format.

Overrides:

toString in class ResponseType

Returns:

a String representation of this object.