LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.data
Class LyError

java.lang.Object
  extended by leon.data.LyError

public class LyError
extends java.lang.Object

This class defines an error on an instance of LyObject.

See Also:
LyObject

Field Summary
static java.lang.String __VERSION
          File version
static short TYPE_CLASS
          Type of error: Error on class
static short TYPE_FIELD
          Type of error: Error on field
 
Constructor Summary
LyError(short level, short type, java.lang.String message, java.lang.Object[] args, LyFieldInfo origin, LyObject objectCause, LyInfoList<LyFieldInfo> fieldInfosCause)
          Constructs an error.
LyError(short level, java.lang.String message, java.lang.Object[] args, LyFieldInfo origin, LyObject objectCause, LyFieldInfo fieldInfoCause)
          Constructs an error.
 
Method Summary
 boolean equals(java.lang.Object o)
          Checks equality between this error and the given one.
 java.lang.Object[] getArgs()
          Returns the arguments of the error message.
 LyInfoList<LyFieldInfo> getFieldInfosCause()
          Return the fieldInfo object of this error.
 java.lang.String getId()
          Gets error id.
 short getLevel()
          Returns the level of this error.
 java.lang.String getMessage()
          Returns the message of this error.
 java.lang.String getMessage(LyEnvironment environment)
          Gets error message expanded with its arguments for the given environment.
 LyObject getObjectCause()
          Return the cause object of this error.
 LyFieldInfo getOrigin()
          Return the origin of this error.
 short getSubType()
          Returns the sub-type of the error.
 java.lang.Object getTransmitter()
          Gets transmitter of the error.
 short getType()
          Returns the type of the error.
 void setTransmitter(java.lang.Object transmitter)
          Sets transmitter of the error.
 java.lang.String toString()
          Dumps this object as a string.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
File version

See Also:
Constant Field Values

TYPE_FIELD

public static short TYPE_FIELD
Type of error: Error on field


TYPE_CLASS

public static short TYPE_CLASS
Type of error: Error on class

Constructor Detail

LyError

public LyError(short level,
               java.lang.String message,
               java.lang.Object[] args,
               LyFieldInfo origin,
               LyObject objectCause,
               LyFieldInfo fieldInfoCause)
Constructs an error. The type of the error is TYPE_FIELD is fiedInfoCause parameter is not null, TYPE_CLASS if null.

Parameters:
level - Level of the error
message - Message associated to this error
args - List of args to the message
origin - Origin of the error. May be null for a class error.
objectCause - Object part cause of the error
fieldInfoCause - FieldInfo part cause of the error. May be null if tha cause is global to the object cause.

LyError

public LyError(short level,
               short type,
               java.lang.String message,
               java.lang.Object[] args,
               LyFieldInfo origin,
               LyObject objectCause,
               LyInfoList<LyFieldInfo> fieldInfosCause)
Constructs an error.

Parameters:
level - Level of the error
type - Type of the error
message - Message associated to this error
args - List of args to the message
origin - Origin of the error. May be null for a class error.
objectCause - Object part cause of the error
fieldInfosCause - List of fieldInfos cause of the error.
Method Detail

getId

public java.lang.String getId()
Gets error id.

Returns:
an id

getType

public short getType()
Returns the type of the error.

Returns:
the type of error

getSubType

public short getSubType()
Returns the sub-type of the error.

Returns:
the sub type of this error

getLevel

public short getLevel()
Returns the level of this error.

Returns:
the error level

getMessage

public java.lang.String getMessage()
Returns the message of this error.

Returns:
the message associated to this error

getArgs

public java.lang.Object[] getArgs()
Returns the arguments of the error message.

Returns:
an array of arguments

getObjectCause

public LyObject getObjectCause()
Return the cause object of this error.

Returns:
the cause object

getFieldInfosCause

public LyInfoList<LyFieldInfo> getFieldInfosCause()
Return the fieldInfo object of this error.

Returns:
a list of fields

getOrigin

public LyFieldInfo getOrigin()
Return the origin of this error.

Returns:
a field

getMessage

public java.lang.String getMessage(LyEnvironment environment)
Gets error message expanded with its arguments for the given environment.

Parameters:
environment - the environment
Returns:
the error message ready to be displayed

equals

public boolean equals(java.lang.Object o)
Checks equality between this error and the given one.

Overrides:
equals in class java.lang.Object
Parameters:
o - the object to compare
Returns:
true if this object and the given object are similar

toString

public java.lang.String toString()
Dumps this object as a string.

Overrides:
toString in class java.lang.Object
Returns:
a string describing this object

getTransmitter

public java.lang.Object getTransmitter()
Gets transmitter of the error.

Returns:
the transmitter

setTransmitter

public void setTransmitter(java.lang.Object transmitter)
Sets transmitter of the error.

Parameters:
transmitter - the transmiter to use

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com