|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ceteca.util.resultMessage.ResultMessage
public class ResultMessage
This class encapsulates the messages returned to the end user as the
result of any user operation in the system.
Responsibilities:
Constructor Summary | |
---|---|
ResultMessage(int resCode)
Constructor for Simple ResultMessage class. |
|
ResultMessage(int resCode,
java.util.ArrayList lParams,
I18n i18n)
Constructor for Parametrized ResultMessage class. |
|
ResultMessage(int resCode,
java.util.ArrayList lParams,
I18n i18n,
java.lang.String fieldName)
Constructor for Parametrized Error ResultMessage class. |
|
ResultMessage(int resCode,
I18n i18n)
Constructor for Simple ResultMessage class. |
|
ResultMessage(int resCode,
java.lang.Throwable cause,
java.util.ArrayList lParams,
I18n i18n,
java.lang.String fieldName)
Constructor for Parametrized Error ResultMessage class. |
|
ResultMessage(int resCode,
java.lang.Throwable cause,
java.util.ArrayList lParams,
java.lang.String fieldName)
Constructor for Parametrized Error ResultMessage class. |
|
ResultMessage(int resCode,
java.lang.Throwable cause,
I18n i18n)
Constructor for Simple Error ResultMessage class. |
Method Summary | |
---|---|
java.lang.Throwable |
getExc()
Gets the exception that raised the result message. |
java.lang.String |
getFieldName()
Gets the name of the field that generated the error message. |
java.util.ArrayList |
getLParams()
Gets the list of parameters and their values, used in the construction of the result message. |
java.lang.String |
getMessage()
Constructs the formatted result message text. |
int |
getResCode()
Gets the result code for the result message. |
java.lang.String |
getResMessage()
Gets the message label that will be used for constructing the formatted error message. |
static java.lang.String |
getRevision()
Returns tag Id assigned to CVS source file. |
void |
setExc(java.lang.Throwable exc)
Sets up the exception that raised the result message. |
void |
setFieldName(java.lang.String fieldName)
Sets up the name of the field that generated the error message. |
void |
setLParams(java.util.ArrayList params)
Sets up the list of parameters and their values, used in the construction of the result message. |
void |
setResCode(int resCode)
Sets up the result code for the result message. |
void |
setResMessage(java.lang.String resMessage)
Sets up the message label that will be used for constructing the formatted error message. |
java.lang.String |
toString()
Format the result message to show it to the end user |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ResultMessage(int resCode)
resCode
- int, result message internal code.public ResultMessage(int resCode, I18n i18n)
resCode
- int, result message internal code.i18n
- I18n, instance of Internationalization object.public ResultMessage(int resCode, java.util.ArrayList lParams, I18n i18n)
resCode
- int, result message internal code.lParams
- ArrayList, list of the parameter values for the message.i18n
- I18n, instance of Internationalization object.public ResultMessage(int resCode, java.util.ArrayList lParams, I18n i18n, java.lang.String fieldName)
resCode
- int, result message internal code.lParams
- ArrayList, list of the parameter values for the message.i18n
- I18n, instance of Internationalization object.fieldName
- String, form field's name linked to the result message.public ResultMessage(int resCode, java.lang.Throwable cause, I18n i18n)
resCode
- int, result message internal code.cause
- Throwable, exception that raised the result message. Only
applies with error messages.i18n
- I18n, instance of Internationalization object.public ResultMessage(int resCode, java.lang.Throwable cause, java.util.ArrayList lParams, java.lang.String fieldName)
resCode
- int, result message internal code.cause
- Throwable, exception that raised the result message. Only
applies with error messages.lParams
- ArrayList, list of the parameter values for the message.fieldName
- String, form field's name linked to the result message.public ResultMessage(int resCode, java.lang.Throwable cause, java.util.ArrayList lParams, I18n i18n, java.lang.String fieldName)
resCode
- int, result message internal code.cause
- Throwable, exception that raised the result message. Only
applies with error messages.lParams
- ArrayList, list of the parameter values for the message.i18n
- I18n, instance of Internationalization object.fieldName
- String, form field's name linked to the result message.Method Detail |
---|
public java.lang.Throwable getExc()
public void setExc(java.lang.Throwable exc)
exc
- Throwable, exception linked to the result message.public java.util.ArrayList getLParams()
public void setLParams(java.util.ArrayList params)
params
- ArrayList, list of result message parameters.public int getResCode()
public void setResCode(int resCode)
resCode
- int, result code.public java.lang.String getResMessage()
public void setResMessage(java.lang.String resMessage)
resMessage
- String, message label.public java.lang.String getFieldName()
public void setFieldName(java.lang.String fieldName)
fieldName
- String, form field's name.public java.lang.String getMessage()
public java.lang.String toString()
toString
in class java.lang.Object
public static java.lang.String getRevision()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |