org.obe.client.api.xpdl
Class ValidationError

java.lang.Object
  org.obe.client.api.xpdl.ValidationError

All Implemented Interfaces:

java.io.Serializable

public final class ValidationError

extends java.lang.Object

implements java.io.Serializable

Holds a validation error as detected by the package validator.

Author:

Adrian Price

See Also:

PackageValidator, Serialized Form

Field Summary

static int	TYPE_ERROR
static int	TYPE_WARNING

Method Summary

java.lang.String	getLocalizedMessage() Returns a localized textual description of the error.
java.lang.String	getMessage() Returns a textual description of the error in English.
java.lang.Object[]	getMessageArgs() Returns the array of replaceable arguments for the message.
int	getMessageCode() Returns the code for the message.
java.lang.Object	getSource() Returns the source workflow object that caused the error.
int	getType() Returns the validation error type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_WARNING

public static final int TYPE_WARNING

See Also:

Constant Field Values

TYPE_ERROR

public static final int TYPE_ERROR

See Also:

Constant Field Values

Method Detail

getMessage

public java.lang.String getMessage()

Returns a textual description of the error in English. N.B. the text differs from that supplied by getLocalizedMessage(), and includes a representation of the full path to the source of the error.

Returns:

Error/warning message.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Returns a localized textual description of the error.

Returns:

Error/warning message.

getMessageArgs

public java.lang.Object[] getMessageArgs()

Returns the array of replaceable arguments for the message.

Returns:

Message arguments.

getMessageCode

public int getMessageCode()

Returns the code for the message.

Returns:

Message code.

getSource

public java.lang.Object getSource()

Returns the source workflow object that caused the error.

Returns:

Error source object.

getType

public int getType()

Returns the validation error type.

Returns:

Error type, one of: TYPE_WARNING, TYPE_ERROR.

toString

public java.lang.String toString()