java.lang.Objectorg.objectweb.telosys.common.TelosysObject
org.objectweb.telosys.service.ServiceResponse
The response of a ScreenService
Constructor Summary | |
ServiceResponse(java.lang.String sServiceName,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
ScreenSession screenSession)
Constructs a new ServiceResponse object |
Method Summary | |
void |
addError(ScreenError error)
Adds an error in the list |
void |
addException(java.lang.Exception ex)
Add an 'Exception' to the exceptions list |
void |
addException(java.lang.Throwable th)
Add a 'Throwable' to the exceptions list |
void |
addMessage(ScreenMessage message)
Adds a message in the list |
void |
expose(java.lang.String sName,
java.lang.Object obj)
Exposes an object in the standard request scope for future use in a view ( the object is stored as an attribute in the HttpServletRequest ) |
void |
forceRedirect(GenericURI uri)
Force the client-side (the browser) to redirect to the given generic URI ( replace the current screen by the given object URL ) |
void |
forceRedirect(java.lang.String sURL)
Force the client-side (the browser) to redirect to the given URL ( replace the current screen by the given URL ) |
ScreenError |
getError(int index)
Returns the error associated with the given index |
java.lang.Exception |
getException(int index)
Returns the exception associated with the given id |
javax.servlet.http.HttpServletRequest |
getHttpRequest()
Returns the "HttpServletRequest" object |
ScreenMessage |
getMessage(int index)
Returns the message associated with the given index |
int |
getNumberOfErrors()
Returns the number of errors |
int |
getNumberOfExceptions()
Returns the number of exception(s) |
int |
getNumberOfMessages()
Returns the number of messages |
int |
getNumberOfValues()
Returns the number of values stored in the response |
java.lang.String |
getRedirection()
Returns the redirection URL set by 'forceRedirect' or null if none |
java.lang.Object |
getResult()
Returns the service result object |
int |
getReturnCode()
Returns the "return code" |
java.lang.String |
getReturnMessage()
Returns the main "return message" |
ScreenSession |
getScreenSession()
Returns the "ScreenSession" object |
java.lang.String |
getServiceName()
Returns the "service name" |
java.lang.String |
getValue(java.lang.String sName)
Returns the response value associated with the given name |
java.util.Enumeration |
getValueNames()
Returns the values names |
void |
setResult(java.lang.Object v)
Set the service result object |
void |
setReturnCode(int iCode)
Set the "return code" |
void |
setReturnMessage(java.lang.String sMsg)
Set the main "return message" |
void |
setValue(java.lang.String sName,
boolean bValue)
Set a 'boolean' value |
void |
setValue(java.lang.String sName,
byte byValue)
Set a 'byte' value |
void |
setValue(java.lang.String sName,
double dValue)
Set a 'double' value |
void |
setValue(java.lang.String sName,
float fValue)
Set a 'float' value |
void |
setValue(java.lang.String sName,
int iValue)
Set an 'int' value |
void |
setValue(java.lang.String sName,
long lValue)
Set a 'long' value |
void |
setValue(java.lang.String sName,
short shValue)
Set a 'short' value |
void |
setValue(java.lang.String sName,
java.lang.String sValue)
Set an 'String' value |
java.lang.String |
toString()
|
Methods inherited from class org.objectweb.telosys.common.TelosysObject |
error, error, error, getFlagTrace, info, setFlagTrace, trace, warn |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ServiceResponse(java.lang.String sServiceName, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, ScreenSession screenSession)
sServiceName
- httpRequest
- httpResponse
- screenSession
- Method Detail |
public java.lang.String getServiceName()
public javax.servlet.http.HttpServletRequest getHttpRequest()
public ScreenSession getScreenSession()
public void setReturnCode(int iCode)
iCode
- public int getReturnCode()
public void setReturnMessage(java.lang.String sMsg)
sMsg
- public java.lang.String getReturnMessage()
public void addMessage(ScreenMessage message)
message
- public int getNumberOfMessages()
public ScreenMessage getMessage(int index)
index
-
public void addError(ScreenError error)
error
- public int getNumberOfErrors()
public ScreenError getError(int index)
index
-
public void addException(java.lang.Exception ex)
ex
- public void addException(java.lang.Throwable th)
th
- public int getNumberOfExceptions()
public java.lang.Exception getException(int index)
index
-
public java.lang.Object getResult()
public void setResult(java.lang.Object v)
v
- public void setValue(java.lang.String sName, java.lang.String sValue)
sName
- sValue
- public void setValue(java.lang.String sName, int iValue)
sName
- iValue
- public void setValue(java.lang.String sName, long lValue)
sName
- lValue
- public void setValue(java.lang.String sName, short shValue)
sName
- shValue
- public void setValue(java.lang.String sName, byte byValue)
sName
- byValue
- public void setValue(java.lang.String sName, float fValue)
sName
- fValue
- public void setValue(java.lang.String sName, double dValue)
sName
- dValue
- public void setValue(java.lang.String sName, boolean bValue)
sName
- bValue
- public java.lang.String getValue(java.lang.String sName)
sName
-
public int getNumberOfValues()
public java.util.Enumeration getValueNames()
public void expose(java.lang.String sName, java.lang.Object obj)
sName
- obj
- public void forceRedirect(java.lang.String sURL)
sURL
- public void forceRedirect(GenericURI uri)
uri
- public java.lang.String getRedirection()
public java.lang.String toString()