org.objectweb.telosys.rpl
Class ScreenRequest

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

public class ScreenRequest
extends TelosysObject


Constructor Summary
ScreenRequest(javax.servlet.http.HttpServletRequest httpRequest)
           
 
Method Summary
 void addView(ScreenRequestView v)
          Adds a view to the request
 boolean elementsAttributeContains(java.lang.String sArgElementName)
          Returns true if the "elements" attribute of the request contains the given element name
 java.lang.String getAction()
          Returns the action attribute of the request
 ScreenDataElements getDataElements()
           
 java.lang.String getElements()
          Returns the "elements" attribute of the request
 java.lang.String[] getElementsArray()
          Returns an array of elements name containing each element of the "elements" attribute
 boolean getFlagClearData()
           
 boolean getFlagGetData()
           
 boolean getFlagSetData()
           
 javax.servlet.http.HttpServletRequest getHttpRequest()
          Returns the standard HTTP servlet request
 javax.servlet.http.HttpSession getHttpSession()
          Returns the standard HTTP session or null if the Http Session doesn't exist It cannot returns null, unless the HttpSession has been invalidate by an external way
 java.lang.String getHttpSessionId()
          Returns the ID of the standard HTTP session
or null if the Http Session doesn't exist It cannot returns null, unless the HttpSession has been invalidate by an external way
 int getIntParameter(java.lang.String sParamName)
           
 java.lang.String getParameter(java.lang.String sParamName)
           
 ScreenRequestParameters getParameters()
           
 java.lang.String getProcName()
          Returns the procedure attribute of the request
 ScreenApplication getScreenApplication()
          Returns the ScreenApplication object associated with the current web app
or null if the ScreenApplication has not yet been created (opened)
It cannot returns null, unless the ServletContext has been corrupted by an external way
 java.lang.String getScreenId()
           
 java.lang.String getScreenName()
           
 ScreenSession getScreenSession()
          Returns the current ScreenSession associated with the request
or null if the HttpSession doesn't exist or if it doesn't contain a ScreenSession attribute
It cannot returns null, unless the HttpSession has been corrupted by an external way
 javax.servlet.ServletContext getServletContext()
          Returns the standard web app ServletContext
or null if the Http Session doesn't exist It cannot returns null, unless the HttpSession has been invalidate by an external way
 ScreenRequestView[] getViews()
          Returns the "views" of the request
 boolean hasElementsAttribute()
          Returns true if the request has an "element" attribute
 boolean hasViews()
          Returns true if the request has one or more "view"
 void setAction(java.lang.String action)
          Set the action attribute of the request
 void setElements(java.lang.String v)
          Set the "elements" attribute of the request
 void setFlagClearData(java.lang.String v)
           
 void setFlagGetData(java.lang.String v)
           
 void setFlagSetData(java.lang.String v)
           
 void setParameter(java.lang.String sParamName, java.lang.String sParamValue)
           
 void setProcName(java.lang.String procName)
          Set the procedure attribute of the request
 void setScreenId(java.lang.String screenId)
           
 void setScreenName(java.lang.String screenName)
           
 void storeDataElement(java.lang.String sTagName, java.lang.Object objData)
          Adds a new element in the request elements list
 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

ScreenRequest

public ScreenRequest(javax.servlet.http.HttpServletRequest httpRequest)
Method Detail

getHttpRequest

public javax.servlet.http.HttpServletRequest getHttpRequest()
Returns the standard HTTP servlet request

Returns:

getHttpSession

public javax.servlet.http.HttpSession getHttpSession()
Returns the standard HTTP session or null if the Http Session doesn't exist It cannot returns null, unless the HttpSession has been invalidate by an external way

Returns:

getHttpSessionId

public java.lang.String getHttpSessionId()
Returns the ID of the standard HTTP session
or null if the Http Session doesn't exist It cannot returns null, unless the HttpSession has been invalidate by an external way

Returns:

getServletContext

public javax.servlet.ServletContext getServletContext()
Returns the standard web app ServletContext
or null if the Http Session doesn't exist It cannot returns null, unless the HttpSession has been invalidate by an external way

Returns:

getScreenSession

public ScreenSession getScreenSession()
Returns the current ScreenSession associated with the request
or null if the HttpSession doesn't exist or if it doesn't contain a ScreenSession attribute
It cannot returns null, unless the HttpSession has been corrupted by an external way

Returns:

getScreenApplication

public ScreenApplication getScreenApplication()
Returns the ScreenApplication object associated with the current web app
or null if the ScreenApplication has not yet been created (opened)
It cannot returns null, unless the ServletContext has been corrupted by an external way

Returns:

getAction

public java.lang.String getAction()
Returns the action attribute of the request

Returns:
the action

setAction

public void setAction(java.lang.String action)
Set the action attribute of the request

Parameters:
action - The action to set.

getProcName

public java.lang.String getProcName()
Returns the procedure attribute of the request

Returns:
the procedure

setProcName

public void setProcName(java.lang.String procName)
Set the procedure attribute of the request

Parameters:
procName - The _sProcName to set.

getScreenId

public java.lang.String getScreenId()
Returns:
Returns the Screen Id.

setScreenId

public void setScreenId(java.lang.String screenId)
Parameters:
screenId - The Screen Id to set.

setScreenName

public void setScreenName(java.lang.String screenName)
Parameters:
screenName - The Screen Name to set.

getScreenName

public java.lang.String getScreenName()
Returns:
Returns the Screen Name.

setElements

public void setElements(java.lang.String v)
Set the "elements" attribute of the request

Parameters:
v -

getElements

public java.lang.String getElements()
Returns the "elements" attribute of the request

Returns:

hasElementsAttribute

public boolean hasElementsAttribute()
Returns true if the request has an "element" attribute

Returns:

getElementsArray

public java.lang.String[] getElementsArray()
Returns an array of elements name containing each element of the "elements" attribute

Returns:

elementsAttributeContains

public boolean elementsAttributeContains(java.lang.String sArgElementName)
Returns true if the "elements" attribute of the request contains the given element name

Parameters:
sArgElementName -
Returns:
true if the element is in the list (else false)

addView

public void addView(ScreenRequestView v)
Adds a view to the request

Parameters:
v -

getViews

public ScreenRequestView[] getViews()
Returns the "views" of the request

Returns:

hasViews

public boolean hasViews()
Returns true if the request has one or more "view"

Returns:

getParameters

public ScreenRequestParameters getParameters()
Returns:
Returns the Request Parameters .

getFlagSetData

public boolean getFlagSetData()

setFlagSetData

public void setFlagSetData(java.lang.String v)

getFlagGetData

public boolean getFlagGetData()

setFlagGetData

public void setFlagGetData(java.lang.String v)

getFlagClearData

public boolean getFlagClearData()

setFlagClearData

public void setFlagClearData(java.lang.String v)

setParameter

public void setParameter(java.lang.String sParamName,
                         java.lang.String sParamValue)

getParameter

public java.lang.String getParameter(java.lang.String sParamName)

getIntParameter

public int getIntParameter(java.lang.String sParamName)
                    throws TelosysException
Throws:
TelosysException

getDataElements

public ScreenDataElements getDataElements()

storeDataElement

public void storeDataElement(java.lang.String sTagName,
                             java.lang.Object objData)
Adds a new element in the request elements list

Parameters:
sTagName -
objData -

toString

public java.lang.String toString()