com.businessobjects.rebean.wi
Class UserInputRequiredException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by com.businessobjects.rebean.wi.REException
                  extended by com.businessobjects.rebean.wi.ServerException
                      extended by com.businessobjects.rebean.wi.UserInputRequiredException
All Implemented Interfaces:
java.io.Serializable

public class UserInputRequiredException
extends ServerException

UserInputRequiredException is thrown when a critical user input is needed.

See Also:
Serialized Form

Field Summary
static int USER_INPUT_FOR_CONTEXT
          Deprecated. This error code corresponds to a possible return value for REException.getErrorCode(), which should no longer be called; use REException.getCode() instead.
static int USER_INPUT_FOR_PROMPT
          Deprecated. This error code corresponds to a possible return value for REException.getErrorCode(), which should no longer be called; use REException.getCode() instead.
 
Constructor Summary
UserInputRequiredException(java.lang.String message, java.lang.String localMessage, int errorCode, java.lang.String fullErrorCode)
           Constructor.
 
Method Summary
 
Methods inherited from class com.businessobjects.rebean.wi.ServerException
getComponent, getErrorType
 
Methods inherited from class com.businessobjects.rebean.wi.REException
getCode, getErrorCode, getLocalizedMessage
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

USER_INPUT_FOR_PROMPT

public static final int USER_INPUT_FOR_PROMPT
Deprecated. This error code corresponds to a possible return value for REException.getErrorCode(), which should no longer be called; use REException.getCode() instead.
User input is required for a prompt in the query.

See Also:
Constant Field Values

USER_INPUT_FOR_CONTEXT

public static final int USER_INPUT_FOR_CONTEXT
Deprecated. This error code corresponds to a possible return value for REException.getErrorCode(), which should no longer be called; use REException.getCode() instead.
User input is required to select an universe context for the query.

See Also:
Constant Field Values
Constructor Detail

UserInputRequiredException

public UserInputRequiredException(java.lang.String message,
                                  java.lang.String localMessage,
                                  int errorCode,
                                  java.lang.String fullErrorCode)

Constructor.

This code is not intended to be called by clients; only REBean should instantiate this type of exception. The format of this constructor can change at any time, without keeping backward compatibility.

Parameters:
message - The error message (default language).
localMessage - A localized version of message (session language).
errorCode - The unique identifier associated with this exception.
fullErrorCode - The error code with the correct prefix.