oracle.sysman.dbTarget.db.changemgr.emo.cpapi
Class ChangePlanAccessException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by oracle.sysman.dbTarget.db.changemgr.emo.cpapi.ChangePlanAccessException
All Implemented Interfaces:
java.io.Serializable

public class ChangePlanAccessException
extends java.lang.Exception

ChangePlanAccessException is a general-purpose Exception thrown by many methods in the ChangePlanAccess family. It defines several reason codes for the various user error conditions that may be encountered while using thie API to work with Change Plans.

See Also:
Serialized Form

Field Summary
static int CP_INVALID_ARG
           
static int CP_ITEM_EXISTS
           
static int CP_ITEM_NOT_EXIST
           
static int CP_MISSING_ARG
           
static int CP_NO_OPEN_PLAN
           
static int CP_NO_PERMISSION
           
static int CP_NO_REASON
           
static int CP_NOT_LOGGED_IN
           
static int CP_PLAN_EXISTS
           
static int CP_PLAN_NOT_EXIST
           
static int CP_UNEXPECTED_XCPN
           
 
Constructor Summary
ChangePlanAccessException(int reason)
          Constructs a ChangePlanAccessException with the specified reason.
ChangePlanAccessException(int reason, java.lang.String message)
          Constructs a ChangePlanAccessException with the specified reason, and a message detailing the problem
ChangePlanAccessException(int reason, java.lang.String message, java.lang.Throwable cause)
          Constructs a ChangePlanAccessException with the specified reason, a message detailing the problem, and the lower-level exception that caused the problem
ChangePlanAccessException(int reason, java.lang.Throwable cause)
          Constructs a ChangePlanAccessException with the specified reason, and the lower-level exception that caused the problem
 
Method Summary
 int getReason()
          Returns the reason the exception was thrown.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CP_NO_REASON

public static final int CP_NO_REASON
See Also:
Constant Field Values

CP_NOT_LOGGED_IN

public static final int CP_NOT_LOGGED_IN
See Also:
Constant Field Values

CP_NO_PERMISSION

public static final int CP_NO_PERMISSION
See Also:
Constant Field Values

CP_PLAN_EXISTS

public static final int CP_PLAN_EXISTS
See Also:
Constant Field Values

CP_PLAN_NOT_EXIST

public static final int CP_PLAN_NOT_EXIST
See Also:
Constant Field Values

CP_NO_OPEN_PLAN

public static final int CP_NO_OPEN_PLAN
See Also:
Constant Field Values

CP_ITEM_NOT_EXIST

public static final int CP_ITEM_NOT_EXIST
See Also:
Constant Field Values

CP_ITEM_EXISTS

public static final int CP_ITEM_EXISTS
See Also:
Constant Field Values

CP_MISSING_ARG

public static final int CP_MISSING_ARG
See Also:
Constant Field Values

CP_INVALID_ARG

public static final int CP_INVALID_ARG
See Also:
Constant Field Values

CP_UNEXPECTED_XCPN

public static final int CP_UNEXPECTED_XCPN
See Also:
Constant Field Values
Constructor Detail

ChangePlanAccessException

public ChangePlanAccessException(int reason)
Constructs a ChangePlanAccessException with the specified reason.

Parameters:
reason - the reason for the exception; see getReason for codes and descriptions.

ChangePlanAccessException

public ChangePlanAccessException(int reason,
                                 java.lang.Throwable cause)
Constructs a ChangePlanAccessException with the specified reason, and the lower-level exception that caused the problem

Parameters:
reason - the reason for the exception; see getReason for codes and descriptions.
cause - The lower-level Exception or Error that caused this exception to be thrown.

ChangePlanAccessException

public ChangePlanAccessException(int reason,
                                 java.lang.String message)
Constructs a ChangePlanAccessException with the specified reason, and a message detailing the problem

Parameters:
reason - the reason for the exception; see getReason for codes and descriptions.
message - A description of the problem.

ChangePlanAccessException

public ChangePlanAccessException(int reason,
                                 java.lang.String message,
                                 java.lang.Throwable cause)
Constructs a ChangePlanAccessException with the specified reason, a message detailing the problem, and the lower-level exception that caused the problem

Parameters:
reason - the reason for the exception; see getReason for codes and descriptions.
message - A description of the problem.
cause - The lower-level Exception or Error that caused this exception to be thrown.
Method Detail

getReason

public int getReason()
Returns the reason the exception was thrown.

Returns:
  • CP_NOT_LOGGED_IN: An operation requiring the user to be logged in was attempted, but the user was not logged in.
  • CP_NO_PERMISSION: The logged-in user does not have permission to perform this action.
  • CP_PLAN_EXISTS: The specified Change Plan already exists.
  • CP_PLAN_NOT_EXIST: The specified Change Plan does not exist.
  • CP_NO_OPEN_PLAN: No Change Plan has been opened.
  • CP_ITEM_NOT_EXIST: The specified change item does not exist.
  • CP_ITEM_EXISTS: The specified change item already exists.
  • CP_MISSING_ARG: An argument that is required for this action was specififed as null.
  • CP_INVALID_ARG: An argument that is invalid for this action was specififed.
  • CP_UNEXPECTED_XCPN: An unexpected exception occurred.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Throwable