Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

oracle.odi.interfaces.data
Class CheckResponse

java.lang.Object
  extended by oracle.odi.interfaces.data.CheckResponse

public class CheckResponse
extends java.lang.Object

An instance of this class contains the response from a IOdiInterfaceExpressionChecker checker. The checker validates an expression owned by an interface subcomponent, and returns a status code and error text.


Nested Class Summary
static class CheckResponse.Response
          An enumeration of the possible response results from checking an expression.
 
Method Summary
static CheckResponse buildConnectionNotFoundResponse(java.lang.String pErrorText)
          For internal use only.
static CheckResponse buildConnectionProblemResponse(java.lang.Throwable pThrowable)
          For internal use only.
static CheckResponse buildDBErrorResponse(java.sql.SQLException pSQLException)
          For internal use only.
static CheckResponse buildInternalErrorResponse(java.lang.String pErrorText, java.lang.Throwable pThrowable)
          For internal use only.
static CheckResponse buildOKResponse()
          For internal use only.
 java.lang.String getErrorText()
          Get the error text associated with the error for this check expression response, of null if there is no error.
 CheckResponse.Response getResponse()
          Get the response code for this check expression response.
 java.sql.SQLException getSQLException()
          Get the SQLException exception associated with the error for this check expression response, or null if there is no error.
 java.lang.Throwable getThrowable()
          Get the Throwable exception associated with the error for this check expression response, or null if there is no error.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

buildConnectionNotFoundResponse

public static CheckResponse buildConnectionNotFoundResponse(java.lang.String pErrorText)
For internal use only.

Parameters:
pErrorText - The error text describing the errors when creating the connection.
Returns:
The new response instance.

buildConnectionProblemResponse

public static CheckResponse buildConnectionProblemResponse(java.lang.Throwable pThrowable)
For internal use only.

Parameters:
pThrowable - The throwable that was thrown when validating the expression.
Returns:
The new response instance.

buildDBErrorResponse

public static CheckResponse buildDBErrorResponse(java.sql.SQLException pSQLException)
For internal use only.

Parameters:
pSQLException - The SQLException that was thrown when validating the expression.
Returns:
The new response instance.

buildInternalErrorResponse

public static CheckResponse buildInternalErrorResponse(java.lang.String pErrorText,
                                                       java.lang.Throwable pThrowable)
For internal use only.

Parameters:
pErrorText - The error text describing the errors found when validating the expression.
pThrowable - The throwable exception thrown when validating the expression, or null if none was thrown.
Returns:
The new response instance.

buildOKResponse

public static CheckResponse buildOKResponse()
For internal use only.

Returns:
The new response instance, with status set to OK.

getErrorText

public java.lang.String getErrorText()
Get the error text associated with the error for this check expression response, of null if there is no error.

Returns:
The error text for this response, if any, else null.

getResponse

public CheckResponse.Response getResponse()
Get the response code for this check expression response.

Returns:
A Response enumeration value.

getSQLException

public java.sql.SQLException getSQLException()
Get the SQLException exception associated with the error for this check expression response, or null if there is no error.

Returns:
the SQLException instance.

getThrowable

public java.lang.Throwable getThrowable()
Get the Throwable exception associated with the error for this check expression response, or null if there is no error.

Returns:
The throwable exception instance.

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

Copyright © 2010, Oracle and/or its affiliates. All rights reserved.