org.objectweb.telosys.screen.env
Class ScreenContextManager

java.lang.Object
  extended byorg.objectweb.telosys.screen.env.ScreenContextManager

public final class ScreenContextManager
extends java.lang.Object

Set of static methods for Screen Context management


Method Summary
static void closeScreenContext(javax.servlet.http.HttpServletRequest request, int iScreenId)
          Close screen context
static void closeScreenContext(ScreenSession screenSession, int iScreenId)
          Close screen context
static ScreenContext findScreenContext(javax.servlet.http.HttpServletRequest httpRequest, int iScreenId)
          Try to find a ScreenContext if possible
Return NULL if cannot be found ( no error )
static ScreenContext findScreenContext(javax.servlet.http.HttpServletRequest httpRequest, int iScreenId, java.lang.String sScreenName)
          Try to find a ScreenContext if possible
Return NULL if cannot be found ( no error )
static ScreenContext getScreenContext(javax.servlet.http.HttpServletRequest request, int iScreenId)
          Try to retrieve an existing screen context associated with the given screen ID
static ScreenContext getScreenContextForName(javax.servlet.http.HttpServletRequest httpRequest, int iScreenId, java.lang.String sScreenName)
          Try to retrieve an existing screen context associated with the given Screen ID and Screen Name
static ScreenContext openScreenContext(javax.servlet.http.HttpServletRequest request, java.lang.String sScreenName, int iScreenId)
          Open (create) a new Screen Context
static ScreenContext openScreenContext(javax.servlet.http.HttpServletRequest request, java.lang.String sScreenName, int iScreenId, ScreenRequestParameters params)
          Open (create) a new Screen Context with parameters
static ScreenContext openScreenContext(ScreenSession screenSession, java.lang.String sScreenName, int iScreenId)
          Open (create) a new Screen Context
static ScreenContext openScreenContext(ScreenSession screenSession, java.lang.String sScreenName, int iScreenId, ScreenRequestParameters params)
          Open (create) a new Screen Context with parameters
static ScreenContext useScreenContext(javax.servlet.http.HttpServletRequest request, java.lang.String sScreenName, int iScreenId)
          Retrieve an existing screen context or create a new one if it doesn't exist
static ScreenContext useScreenContext(javax.servlet.http.HttpServletRequest request, java.lang.String sScreenName, int iScreenId, ScreenRequestParameters params)
          Retrieve an existing screen context or create a new one if it doesn't exist
static ScreenContext useScreenContext(ScreenSession screenSession, java.lang.String sScreenName, int iScreenId)
          Retrieve an existing screen context or create a new one if it doesn't exist
static ScreenContext useScreenContext(ScreenSession screenSession, java.lang.String sScreenName, int iScreenId, ScreenRequestParameters params)
          Retrieve an existing screen context or create a new one if it doesn't exist
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

findScreenContext

public static ScreenContext findScreenContext(javax.servlet.http.HttpServletRequest httpRequest,
                                              int iScreenId)
Try to find a ScreenContext if possible
Return NULL if cannot be found ( no error )

Parameters:
httpRequest -
iScreenId -
Returns:
the ScreenContext found or null if not found

findScreenContext

public static ScreenContext findScreenContext(javax.servlet.http.HttpServletRequest httpRequest,
                                              int iScreenId,
                                              java.lang.String sScreenName)
Try to find a ScreenContext if possible
Return NULL if cannot be found ( no error )

Parameters:
httpRequest -
iScreenId -
sScreenName -
Returns:
the ScreenContext found or null if not found

getScreenContext

public static ScreenContext getScreenContext(javax.servlet.http.HttpServletRequest request,
                                             int iScreenId)
                                      throws TelosysException
Try to retrieve an existing screen context associated with the given screen ID

Parameters:
request -
iScreenId -
Returns:
the ScreenContext or null if not found
Throws:
TelosysException

getScreenContextForName

public static ScreenContext getScreenContextForName(javax.servlet.http.HttpServletRequest httpRequest,
                                                    int iScreenId,
                                                    java.lang.String sScreenName)
                                             throws TelosysException
Try to retrieve an existing screen context associated with the given Screen ID and Screen Name

Parameters:
httpRequest -
iScreenId -
sScreenName -
Returns:
the ScreenContext or null if not found
Throws:
TelosysException

openScreenContext

public static ScreenContext openScreenContext(javax.servlet.http.HttpServletRequest request,
                                              java.lang.String sScreenName,
                                              int iScreenId)
                                       throws TelosysException
Open (create) a new Screen Context

Parameters:
request -
sScreenName -
iScreenId - the ScreenContext ID to use, or (since 1.0.4) a negative value for "next available ID"
Returns:
Throws:
TelosysException

openScreenContext

public static ScreenContext openScreenContext(javax.servlet.http.HttpServletRequest request,
                                              java.lang.String sScreenName,
                                              int iScreenId,
                                              ScreenRequestParameters params)
                                       throws TelosysException
Open (create) a new Screen Context with parameters

Parameters:
request -
sScreenName -
iScreenId - the ScreenContext ID to use, or (since 1.0.4) a negative value for "next available ID"
params -
Returns:
Throws:
TelosysException

openScreenContext

public static ScreenContext openScreenContext(ScreenSession screenSession,
                                              java.lang.String sScreenName,
                                              int iScreenId)
                                       throws TelosysException
Open (create) a new Screen Context

Parameters:
screenSession -
sScreenName -
iScreenId - the ScreenContext ID to use, or (since 1.0.4) a negative value for "next available ID"
Returns:
Throws:
TelosysException

openScreenContext

public static ScreenContext openScreenContext(ScreenSession screenSession,
                                              java.lang.String sScreenName,
                                              int iScreenId,
                                              ScreenRequestParameters params)
                                       throws TelosysException
Open (create) a new Screen Context with parameters

Parameters:
screenSession -
sScreenName - the name of the ScreenContext
iScreenId - the ScreenContext ID to use, or (since 1.0.4) a negative value for "next available ID"
params -
Returns:
Throws:
TelosysException

closeScreenContext

public static void closeScreenContext(javax.servlet.http.HttpServletRequest request,
                                      int iScreenId)
                               throws TelosysException
Close screen context

Parameters:
request -
iScreenId -
Throws:
TelosysException

closeScreenContext

public static void closeScreenContext(ScreenSession screenSession,
                                      int iScreenId)
                               throws TelosysException
Close screen context

Parameters:
screenSession -
iScreenId -
Throws:
TelosysException

useScreenContext

public static ScreenContext useScreenContext(javax.servlet.http.HttpServletRequest request,
                                             java.lang.String sScreenName,
                                             int iScreenId)
                                      throws TelosysException
Retrieve an existing screen context or create a new one if it doesn't exist

Parameters:
request -
sScreenName -
iScreenId -
Returns:
Throws:
TelosysException

useScreenContext

public static ScreenContext useScreenContext(javax.servlet.http.HttpServletRequest request,
                                             java.lang.String sScreenName,
                                             int iScreenId,
                                             ScreenRequestParameters params)
                                      throws TelosysException
Retrieve an existing screen context or create a new one if it doesn't exist

Parameters:
request -
sScreenName -
iScreenId -
params -
Returns:
Throws:
TelosysException

useScreenContext

public static ScreenContext useScreenContext(ScreenSession screenSession,
                                             java.lang.String sScreenName,
                                             int iScreenId)
                                      throws TelosysException
Retrieve an existing screen context or create a new one if it doesn't exist

Parameters:
screenSession -
sScreenName -
iScreenId -
Returns:
Throws:
TelosysException

useScreenContext

public static ScreenContext useScreenContext(ScreenSession screenSession,
                                             java.lang.String sScreenName,
                                             int iScreenId,
                                             ScreenRequestParameters params)
                                      throws TelosysException
Retrieve an existing screen context or create a new one if it doesn't exist

Parameters:
screenSession -
sScreenName -
iScreenId - the ScreenContext ID ( cannot be < 0 )
params -
Returns:
Throws:
TelosysException