edu.harvard.cfa.vo.tapclient.tap
Class Error

java.lang.Object
  extended by edu.harvard.cfa.vo.tapclient.tap.Error

public class Error
extends java.lang.Object

An object that can be used to get information about error conditions resulting from an asynchronous query.

See Also:
AsyncJob

Method Summary
 java.lang.String getMessage()
          Returns the error message for this error summary
 java.lang.String getType()
          Returns the error type for this error summary
 boolean isDetailedErrorAvailable()
          Returns true if a detailed error is available on the TAP service
 void list(java.io.PrintStream output)
           
 java.io.InputStream openStream()
          Returns an InputStream containing the TAP service response to a request for the detailed error.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getMessage

public java.lang.String getMessage()
Returns the error message for this error summary

Returns:
message of this error summary

getType

public java.lang.String getType()
Returns the error type for this error summary

Returns:
error type of this error summary

isDetailedErrorAvailable

public boolean isDetailedErrorAvailable()
Returns true if a detailed error is available on the TAP service

Returns:
true if a detailed error is availabile, false otherwise

openStream

public java.io.InputStream openStream()
                               throws HttpException,
                                      java.io.IOException
Returns an InputStream containing the TAP service response to a request for the detailed error. The result of this request is undefined if isDetailedErrorAvailable returns false.

Returns:
InputStream detailed error response from TAP service.
Throws:
HttpException - if the service responses with an unexpected HTTP status.
java.io.IOException - if an error occurs creating the InputStream
java.lang.NullPointerException - if either service or jobId is null
See Also:
isDetailedErrorAvailable()

list

public void list(java.io.PrintStream output)
          throws HttpException,
                 java.io.IOException
Throws:
HttpException
java.io.IOException