org.kuali.kra.s2s

Class S2SException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.kuali.kra.s2s.S2SException

All Implemented Interfaces:

Serializable

public class S2SException
extends Exception

This class is used to handle general Exceptions

Author:

Kuali Research Administration Team (kualidev@oncourse.iu.edu)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
S2SException() Creates new KraException without detail message.
S2SException(Exception ex) Creates new KraException with detail message.
S2SException(String msg) Constructs an KraException with the specified detail message.
S2SException(String message, Exception ex) Creates new KraException with detail message.
S2SException(String msg, int messageType)
S2SException(String errorKey, String msg)
S2SException(String errorKey, String msg, String... params)

Method Summary

Methods

Modifier and Type	Method and Description
String	getErrorKey() Gets the errorKey attribute.
String	getMessage() Get Error Message
int	getMessageType() Getter for property messageType.
String[]	getMessageWithParams() This method returns message as first element followed by all params
String[]	getParams() Gets the params attribute.
String	getUserMessage() This Method is used to get the User Assigned Message.
void	setErrorKey(String errorKey) Sets the errorKey attribute value.
void	setMessage(String msg) Set Error Message
void	setMessageType(int messageType) Setter for property messageType.
void	setParams(String[] params) Sets the params attribute value.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

Constructor Detail

S2SException

public S2SException()

Creates new KraException without detail message.

S2SException

public S2SException(Exception ex)

Creates new KraException with detail message.

Parameters:

ex -

S2SException

public S2SException(String message,
            Exception ex)

Creates new KraException with detail message.

Parameters:

ex -

S2SException

public S2SException(String msg)

Constructs an KraException with the specified detail message.

Parameters:

msg - errorMessage the detail message.

S2SException

public S2SException(String errorKey,
            String msg)

S2SException

public S2SException(String errorKey,
            String msg,
            String... params)

S2SException

public S2SException(String msg,
            int messageType)

Method Detail

getMessage

public String getMessage()

Get Error Message

Overrides:

getMessage in class Throwable

getMessageWithParams

public String[] getMessageWithParams()

This method returns message as first element followed by all params

Returns:

setMessage

public void setMessage(String msg)

Set Error Message

Parameters:

msg - String Error Message

getUserMessage

public String getUserMessage()

This Method is used to get the User Assigned Message.

Returns:

String user defined erronous message

getMessageType

public int getMessageType()

Getter for property messageType.

Returns:

Value of property messageType.

setMessageType

public void setMessageType(int messageType)

Setter for property messageType.

Parameters:

messageType - New value of property errorType.

getErrorKey

public String getErrorKey()

Gets the errorKey attribute.

Returns:

Returns the errorKey.

setErrorKey

public void setErrorKey(String errorKey)

Sets the errorKey attribute value.

Parameters:

errorKey - The errorKey to set.

getParams

public String[] getParams()

Gets the params attribute.

Returns:

Returns the params.

setParams

public void setParams(String[] params)

Sets the params attribute value.

Parameters:

params - The params to set.