org.objectweb.telosys.rpl
Class ScreenResponse

java.lang.Object
  extended byorg.objectweb.telosys.common.TelosysObject
      extended byorg.objectweb.telosys.rpl.ScreenResponse

public class ScreenResponse
extends TelosysObject


Field Summary
static int ACTION_CANCELED
           
static int ACTION_ERROR
           
static int ACTION_OK
           
static int INVALID_ACTION
           
static int INVALID_SCREEN_ID
           
static int SCREEN_NOT_FOUND
           
 
Constructor Summary
ScreenResponse(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, java.lang.String sScreenName, java.lang.String sScreenId, java.lang.String sAction, java.lang.String sProcName)
          Constructor
 
Method Summary
 void addError(ScreenError error)
           
 void addError(java.lang.Throwable th)
           
 void addMessage(ScreenMessage message)
           
 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 )
 java.lang.String getAction()
           
 ScreenDataElements getDataElements()
           
 ScreenError getError(int index)
           
 java.lang.Throwable getException(int index)
           
 ScreenMessage getMessage(int index)
           
 int getNumberOfErrors()
           
 int getNumberOfExceptions()
           
 int getNumberOfMessages()
           
 int getNumberOfValues()
           
 java.lang.String getProcName()
           
 java.lang.String getRedirection()
          Returns the redirection URL set by 'forceRedirect' or null if none
 int getReturnCode()
           
 java.lang.String getReturnMessage()
           
 java.lang.String getScreenId()
           
 java.lang.String getScreenName()
           
 java.lang.String getValue(java.lang.String sName)
           
 java.util.Enumeration getValueNames()
           
 boolean isFlagFound()
           
 boolean isFlagNotFound()
           
 void setActionReturn(int iActionReturnCode)
           
 void setDataElements(ScreenData data)
           
 void setDataElements(ScreenDataElements dataElements)
           
 void setFlagFound()
           
 void setFlagNotFound()
           
 void setReturnCode(int iCode)
           
 void setReturnMessage(java.lang.String sMsg)
           
 void setValue(java.lang.String sName, int iValue)
           
 void setValue(java.lang.String sName, java.lang.String sValue)
           
 java.lang.String toString()
           
 void unsetFlagFound()
           
 void unsetFlagNotFound()
           
 
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
 

Field Detail

ACTION_OK

public static final int ACTION_OK
See Also:
Constant Field Values

ACTION_CANCELED

public static final int ACTION_CANCELED
See Also:
Constant Field Values

ACTION_ERROR

public static final int ACTION_ERROR
See Also:
Constant Field Values

INVALID_ACTION

public static final int INVALID_ACTION
See Also:
Constant Field Values

INVALID_SCREEN_ID

public static final int INVALID_SCREEN_ID
See Also:
Constant Field Values

SCREEN_NOT_FOUND

public static final int SCREEN_NOT_FOUND
See Also:
Constant Field Values
Constructor Detail

ScreenResponse

public ScreenResponse(javax.servlet.http.HttpServletRequest httpRequest,
                      javax.servlet.http.HttpServletResponse httpResponse,
                      java.lang.String sScreenName,
                      java.lang.String sScreenId,
                      java.lang.String sAction,
                      java.lang.String sProcName)
Constructor

Parameters:
httpRequest -
httpResponse -
sScreenName -
sScreenId -
sAction -
sProcName -
Method Detail

getScreenName

public java.lang.String getScreenName()

getScreenId

public java.lang.String getScreenId()

getAction

public java.lang.String getAction()

getProcName

public java.lang.String getProcName()

setReturnCode

public void setReturnCode(int iCode)

getReturnCode

public int getReturnCode()

setActionReturn

public void setActionReturn(int iActionReturnCode)

setReturnMessage

public void setReturnMessage(java.lang.String sMsg)

getReturnMessage

public java.lang.String getReturnMessage()

isFlagNotFound

public boolean isFlagNotFound()

setFlagNotFound

public void setFlagNotFound()

unsetFlagNotFound

public void unsetFlagNotFound()

isFlagFound

public boolean isFlagFound()

setFlagFound

public void setFlagFound()

unsetFlagFound

public void unsetFlagFound()

addMessage

public void addMessage(ScreenMessage message)

getNumberOfMessages

public int getNumberOfMessages()

getMessage

public ScreenMessage getMessage(int index)

addError

public void addError(ScreenError error)

getNumberOfErrors

public int getNumberOfErrors()

getError

public ScreenError getError(int index)

addError

public void addError(java.lang.Throwable th)

getNumberOfExceptions

public int getNumberOfExceptions()

getException

public java.lang.Throwable getException(int index)

getDataElements

public ScreenDataElements getDataElements()

setDataElements

public void setDataElements(ScreenData data)

setDataElements

public void setDataElements(ScreenDataElements dataElements)

setValue

public void setValue(java.lang.String sName,
                     java.lang.String sValue)

setValue

public void setValue(java.lang.String sName,
                     int iValue)

getValue

public java.lang.String getValue(java.lang.String sName)

getNumberOfValues

public int getNumberOfValues()

getValueNames

public java.util.Enumeration getValueNames()

forceRedirect

public 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 )

Parameters:
sURL -

forceRedirect

public 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 )

Parameters:
uri -

getRedirection

public java.lang.String getRedirection()
Returns the redirection URL set by 'forceRedirect' or null if none

Returns:

toString

public java.lang.String toString()