uk.org.ogsadai.client.toolkit
Interface Response

All Known Implementing Classes:
ActivityResponse, DocumentResponse

public interface Response

The response returned by a data service after it has processed a request.

The response is an XML document that contains the status and possibly the output of each activity in the request. If the request was a uk.org.ogsadai.client.toolkit.activity.ActivityRequest the status and output of each activity can be obtained from the individual uk.org.ogsadai.client.toolkit.activity.Activity objects making up the request.

Author:
The OGSA-DAI Project Team

Method Summary
 java.lang.String getAsString()
          Gets the response document in its unprocessed XML form as a String.
 AttachmentManager getAttachmentManager()
          Gets the attachment manager object that provides convenient access to attachmens data.
 org.w3c.dom.Document getDocument()
          Gets the response as in its unprocessed XML form.
 RequestStatus getRequestStatus()
          Gets the status of the request as contained in the response.
 Session getSession()
          Gets the session details from the response.
 

Method Detail

getDocument

public org.w3c.dom.Document getDocument()
Gets the response as in its unprocessed XML form.

Returns:
the response document

getAsString

public java.lang.String getAsString()
Gets the response document in its unprocessed XML form as a String.

Returns:
the response document

getSession

public Session getSession()
Gets the session details from the response. These identify the session that the corresponding request was joined to.

Returns:
a Session object identifying the session.

getRequestStatus

public RequestStatus getRequestStatus()
Gets the status of the request as contained in the response.

Returns:
status of the request.

getAttachmentManager

public AttachmentManager getAttachmentManager()
Gets the attachment manager object that provides convenient access to attachmens data.

Returns:
Attachment manager object.