org.objectweb.telosys.rpl
Class ScreenResponse

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

public class ScreenResponse
extends GenericResponse

The response object populated by a "Screen Action"


Field Summary
static int ACTION_CANCELED
           
static int ACTION_ERROR
           
static int ACTION_OK
           
static int INVALID_ACTION
           
static int INVALID_HTTP_METHOD
           
 
Fields inherited from class org.objectweb.telosys.rpl.GenericResponse
ERRORS, EXCEPTIONS, MESSAGES, REDIRECTION, RETURN, VALUES
 
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
 java.lang.String getAction()
          Returns the Screen Action that will be returned in the response
 ScreenDataElements getDataElements()
          Returns the Data Elements that will be returned in the response
 java.lang.String getProcName()
          Returns the Procedure Name (if any) that will be returned in the response
 java.lang.String getScreenId()
          Returns the Screen ID that will be returned in the response
 java.lang.String getScreenName()
          Returns the Screen Name that will be returned in the response
 boolean isFlagFound()
          Returns the "Found" flag value
 boolean isFlagNotFound()
          Returns the "Not Found" flag value
 void setActionReturn(int iReturnCode)
          Set the action predefined return code
NB : reserved for the framework usage ( do not use in the application level )
 void setDataElements(ScreenData data)
          Set the Data Elements to return in the response from the given Screen Data
 void setDataElements(ScreenDataElements dataElements)
          Set the Data Elements to return in the response
 void setFlagFound()
          Set the "Found" flag to "TRUE", and the "NotFound" flag to "FALSE"
 void setFlagNotFound()
          Set the "Not Found" flag to "TRUE", and the "Found" flag to false
 java.lang.String toString()
           
 void unsetFlagFound()
          Set the "Found" flag to "FALSE"
 void unsetFlagNotFound()
          Set the "Not Found" flag to "FALSE"
 
Methods inherited from class org.objectweb.telosys.rpl.GenericResponse
addError, addException, addMessage, expose, forceRedirect, forceRedirect, getError, getException, getHttpRequest, getHttpResponse, getMessage, getNumberOfErrors, getNumberOfExceptions, getNumberOfMessages, getNumberOfValues, getRedirection, getReturnCode, getReturnMessage, getValue, getValueNames, setReturnCode, setReturnMessage, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, 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
 

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_HTTP_METHOD

public static final int INVALID_HTTP_METHOD
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()
Returns the Screen Name that will be returned in the response

Returns:

getScreenId

public java.lang.String getScreenId()
Returns the Screen ID that will be returned in the response

Returns:

getAction

public java.lang.String getAction()
Returns the Screen Action that will be returned in the response

Returns:

getProcName

public java.lang.String getProcName()
Returns the Procedure Name (if any) that will be returned in the response

Returns:

setActionReturn

public void setActionReturn(int iReturnCode)
Set the action predefined return code
NB : reserved for the framework usage ( do not use in the application level )

Parameters:
iReturnCode -

isFlagNotFound

public boolean isFlagNotFound()
Returns the "Not Found" flag value

Returns:

setFlagNotFound

public void setFlagNotFound()
Set the "Not Found" flag to "TRUE", and the "Found" flag to false


unsetFlagNotFound

public void unsetFlagNotFound()
Set the "Not Found" flag to "FALSE"


isFlagFound

public boolean isFlagFound()
Returns the "Found" flag value

Returns:

setFlagFound

public void setFlagFound()
Set the "Found" flag to "TRUE", and the "NotFound" flag to "FALSE"


unsetFlagFound

public void unsetFlagFound()
Set the "Found" flag to "FALSE"


getDataElements

public ScreenDataElements getDataElements()
Returns the Data Elements that will be returned in the response

Returns:

setDataElements

public void setDataElements(ScreenData data)
Set the Data Elements to return in the response from the given Screen Data

Parameters:
data -

setDataElements

public void setDataElements(ScreenDataElements dataElements)
Set the Data Elements to return in the response

Parameters:
dataElements -

toString

public java.lang.String toString()