com.ibm.itim.script
Class ScriptEvaluationError

java.lang.Object
  com.ibm.itim.script.ScriptEvaluationError

All Implemented Interfaces:

ExtensionBean, java.io.Serializable

public class ScriptEvaluationError
extends java.lang.Object
implements ExtensionBean, java.io.Serializable

The purpose of this class is to communicate to the client the nature of the script evaluaiton error.

Since:

4.6

See Also:

ScriptException, Serialized Form

Constructor Summary

ScriptEvaluationError()
Default constructor

Method Summary

int	getErrorCode() Return error code
java.lang.String	getMessage() Returns a description of the error in a case when script writer chooses to describe the nature of the error in more detail - i.e.
void	setErrorCode(int errorCode) Set an evaluation context specific error code.
void	setMessage(java.lang.String errorMessage) Sets a description of the error in a case when script writer chooses to describe the nature of the error in more detail - i.e.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptEvaluationError

public ScriptEvaluationError()

Default constructor

Method Detail

getErrorCode

public int getErrorCode()

Return error code

Returns:

int value representing error code, which should be always greater then 0 and may be specific to the evaluation context.

setErrorCode

public void setErrorCode(int errorCode)

Set an evaluation context specific error code.

Parameters:

errorCode - int value representing error code, which should be always greater then 0 and may be specific to the evaluation context.

getMessage

public java.lang.String getMessage()

Returns a description of the error in a case when script writer chooses to describe the nature of the error in more detail - i.e. for logging purposes.

Returns:

Description of the error set by the script author from within the script itself.

setMessage

public void setMessage(java.lang.String errorMessage)

Sets a description of the error in a case when script writer chooses to describe the nature of the error in more detail - i.e. for logging purposes.

Parameters:

errorMessage - Description of the error set by the script author from within the script itself.