com.konakartadmin.app

Class KKAdminException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.konakartadmin.app.KKAdminException

All Implemented Interfaces:

java.io.Serializable

public class KKAdminException
extends java.lang.Exception

An exception in the Admin App

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	API_ERROR Unknown API error exception code
int	code A code that can be used to indicate the type of exception
static int	CUSTOMER_NOT_FOUND Customer Not Found exception code
static java.lang.String	EXCEPTION_MSG If this text is changed, you need to edit com.konakartadmin.client.util.KKExceptionDialog.java since it searches for this text to show the exception message in the dialog box
boolean	hideMoreDetails Can be used to hide the "More Details" button on the Exception warning dialogue inside the Admin App.
static int	INVALID_SESSION Store deleted exception code - multi-store only
static int	KK_PASSWORD_EXPIRED User's password has expired
java.lang.String	msgKey A key for a message that can be used to Internationalize the exception message.
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
KKAdminException() KKAdminException
KKAdminException(java.lang.String msg)
KKAdminException(java.lang.String msg, boolean hideMoreDetails)
KKAdminException(java.lang.String msg, java.lang.String key)
KKAdminException(java.lang.String msg, java.lang.String key, boolean hideMoreDetails)
KKAdminException(java.lang.String msg, java.lang.String key, java.lang.Throwable nested) Constructs a new KKAdminException with specified detail message and nested Throwable.
KKAdminException(java.lang.String msg, java.lang.Throwable nested) Constructs a new KKAdminException with specified detail message and nested Throwable.
KKAdminException(java.lang.Throwable nested) Constructs a new KKException with specified nested Throwable.

Method Summary

Modifier and Type	Method and Description
int	getCode()
private static java.lang.String	getExceptionMessage(java.lang.String msg) Returns a string containing the msg with the version number appended (but only once)
private static java.lang.String	getExceptionMessage(java.lang.String msg, java.lang.Throwable e) Returns a string containing the stack trace of the exception and its cause
static java.lang.String	getExceptionMessagePrefic() Returns the standard Exception Msg prefix
java.lang.String	getMsgKey()
boolean	isHideMoreDetails()
void	setCode(int code)
void	setHideMoreDetails(boolean hideMoreDetails)
void	setMsgKey(java.lang.String msgKey)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

KK_PASSWORD_EXPIRED

public static final int KK_PASSWORD_EXPIRED

User's password has expired

See Also:

Constant Field Values

INVALID_SESSION

public static final int INVALID_SESSION

Store deleted exception code - multi-store only

See Also:

Constant Field Values

CUSTOMER_NOT_FOUND

public static final int CUSTOMER_NOT_FOUND

Customer Not Found exception code

See Also:

Constant Field Values

API_ERROR

public static final int API_ERROR

Unknown API error exception code

See Also:

Constant Field Values

EXCEPTION_MSG

public static final java.lang.String EXCEPTION_MSG

If this text is changed, you need to edit com.konakartadmin.client.util.KKExceptionDialog.java since it searches for this text to show the exception message in the dialog box

See Also:

Constant Field Values

code

public int code

A code that can be used to indicate the type of exception

msgKey

public java.lang.String msgKey

A key for a message that can be used to Internationalize the exception message. The key is defined in the AdminMessages*.properties message catalog (or in the database if the store is configured to store messages in the database).

hideMoreDetails

public boolean hideMoreDetails

Can be used to hide the "More Details" button on the Exception warning dialogue inside the Admin App. This can be useful if you are doing some custom validation in a custom engine and throwing an exception to indicate an error but you don't want the user to see any more detail than the main exception message.

Constructor Detail

KKAdminException

public KKAdminException()

KKAdminException

KKAdminException

public KKAdminException(java.lang.String msg)

Parameters:

msg - the msg

KKAdminException

public KKAdminException(java.lang.String msg,
                        java.lang.String key)

Parameters:

msg - the exception message in the default language

key - message catalog key

KKAdminException

public KKAdminException(java.lang.String msg,
                        java.lang.String key,
                        boolean hideMoreDetails)

Parameters:

msg - the exception message in the default language

key - message catalog key

hideMoreDetails - set to true to hide the "More Details" button on the Exception warning dialogue inside the Admin App

KKAdminException

public KKAdminException(java.lang.String msg,
                        boolean hideMoreDetails)

Parameters:

msg - the message for the exception

hideMoreDetails - set to true to hide the "More Details" button on the Exception warning dialogue inside the Admin App

KKAdminException

public KKAdminException(java.lang.Throwable nested)

Constructs a new KKException with specified nested Throwable.

Parameters:

nested - the exception or error that caused this exception to be thrown.

KKAdminException

public KKAdminException(java.lang.String msg,
                        java.lang.Throwable nested)

Constructs a new KKAdminException with specified detail message and nested Throwable.

Parameters:

msg - the error message.

nested - the exception or error that caused this exception to be thrown.

KKAdminException

public KKAdminException(java.lang.String msg,
                        java.lang.String key,
                        java.lang.Throwable nested)

Constructs a new KKAdminException with specified detail message and nested Throwable.

Parameters:

msg - the error message.

key - message catalog key

nested - the exception or error that caused this exception to be thrown.

Method Detail

getExceptionMessagePrefic

public static java.lang.String getExceptionMessagePrefic()

Returns the standard Exception Msg prefix

Returns:

Returns a string containing the standard Exception Msg prefix

getExceptionMessage

private static java.lang.String getExceptionMessage(java.lang.String msg)

Returns a string containing the msg with the version number appended (but only once)

Parameters:

msg - the message for the exception

Returns:

Returns a string containing the stack trace

getExceptionMessage

private static java.lang.String getExceptionMessage(java.lang.String msg,
                                                    java.lang.Throwable e)

Returns a string containing the stack trace of the exception and its cause

Parameters:

msg - the message for the exception

e - the exception

Returns:

Returns a string containing the stack trace

getCode

public int getCode()

Returns:

the code

setCode

public void setCode(int code)

Parameters:

code - the code to set

isHideMoreDetails

public boolean isHideMoreDetails()

Returns:

the hideMoreDetails

setHideMoreDetails

public void setHideMoreDetails(boolean hideMoreDetails)

Parameters:

hideMoreDetails - the hideMoreDetails to set

getMsgKey

public java.lang.String getMsgKey()

Returns:

the msgKey

setMsgKey

public void setMsgKey(java.lang.String msgKey)

Parameters:

msgKey - the msgKey to set