org.objectweb.telosys.screen.core
Interface ScreenManager

All Known Implementing Classes:
StandardScreenManager

public interface ScreenManager

The ScreenManager interface
Defines all the methods that must be implemented by a SCREEN MANAGER


Method Summary
 void doDelete(ScreenData screenData, ScreenContext screenContext, ScreenRequest request, ScreenResponse response, DatabaseSession session)
          Entry point for "delete" action
 void doInit(ScreenData screenData, ScreenContext screenContext, java.util.Map param, DatabaseSession dbSession)
          Deprecated. no longer used by the framework, do not use
 void doInsert(ScreenData screenData, ScreenContext screenContext, ScreenRequest request, ScreenResponse response, DatabaseSession session)
          Entry point for "insert" action
 void doLoad(ScreenData screenData, ScreenContext screenContext, ScreenRequest request, ScreenResponse response, DatabaseSession session)
          Entry point for "load" action
 void doSave(ScreenData screenData, ScreenContext screenContext, ScreenRequest request, ScreenResponse response, DatabaseSession session)
          Entry point for "save" action
 void doUpdate(ScreenData screenData, ScreenContext screenContext, ScreenRequest request, ScreenResponse response, DatabaseSession session)
          Entry point for "update" action
 void eventCreate(ScreenContext screenContext, ScreenRequestParameters params, ScreenSession screenSession, DatabaseSession session)
          Entry point for a "create event", origin : ScreenContextManager ("open" or "use" and not found)
 void eventReuse(ScreenContext screenContext, ScreenRequestParameters params, ScreenSession screenSession, DatabaseSession session)
          Entry point for a "reuse event", origin : ScreenContextManager ("use" and found)
 int getDatabaseId()
          Returns the Database Id used by the ScreenManager . 0 to N : the Databse Id specified .
 DatabaseSession getDatabaseSession()
          Returns a new DatabaseSession instance corresponding to
the DatabaseId associated with the current screen context.
 

Method Detail

getDatabaseSession

public DatabaseSession getDatabaseSession()
                                   throws TelosysException
Returns a new DatabaseSession instance corresponding to
the DatabaseId associated with the current screen context.
NB :
. each call returns a NEW INSTANCE
This instance is not the same as the DatabaseSession parameter used in
the ScreenManager methods, and it is not stored as thread-local variable.
. it's the programmer's reponsability to managed the DatabaseSession return
e.g. : this DatabaseSession must be closed after use. In classical cases, this method is not supposed to be used

Returns:
Throws:
TelosysException

getDatabaseId

public int getDatabaseId()
Returns the Database Id used by the ScreenManager . 0 to N : the Databse Id specified . DEFAULT_DATABASE : the default database id defined in the Data Access Layer . NO_DATABASE : the ScreenManager is not supposed to use a database

Returns:
Since:
v 1.0.2

doInit

public void doInit(ScreenData screenData,
                   ScreenContext screenContext,
                   java.util.Map param,
                   DatabaseSession dbSession)
            throws TelosysException
Deprecated. no longer used by the framework, do not use

Parameters:
screenData -
screenContext -
param -
dbSession -
Throws:
TelosysException

doLoad

public void doLoad(ScreenData screenData,
                   ScreenContext screenContext,
                   ScreenRequest request,
                   ScreenResponse response,
                   DatabaseSession session)
            throws TelosysException
Entry point for "load" action

Parameters:
screenData -
screenContext -
request -
response -
session -
Throws:
TelosysException

doSave

public void doSave(ScreenData screenData,
                   ScreenContext screenContext,
                   ScreenRequest request,
                   ScreenResponse response,
                   DatabaseSession session)
            throws TelosysException
Entry point for "save" action

Parameters:
screenData -
screenContext -
request -
response -
session -
Throws:
TelosysException

doInsert

public void doInsert(ScreenData screenData,
                     ScreenContext screenContext,
                     ScreenRequest request,
                     ScreenResponse response,
                     DatabaseSession session)
              throws TelosysException
Entry point for "insert" action

Parameters:
screenData -
screenContext -
request -
response -
session -
Throws:
TelosysException

doUpdate

public void doUpdate(ScreenData screenData,
                     ScreenContext screenContext,
                     ScreenRequest request,
                     ScreenResponse response,
                     DatabaseSession session)
              throws TelosysException
Entry point for "update" action

Parameters:
screenData -
screenContext -
request -
response -
session -
Throws:
TelosysException

doDelete

public void doDelete(ScreenData screenData,
                     ScreenContext screenContext,
                     ScreenRequest request,
                     ScreenResponse response,
                     DatabaseSession session)
              throws TelosysException
Entry point for "delete" action

Parameters:
screenData -
screenContext -
request -
response -
session -
Throws:
TelosysException

eventCreate

public void eventCreate(ScreenContext screenContext,
                        ScreenRequestParameters params,
                        ScreenSession screenSession,
                        DatabaseSession session)
                 throws TelosysException
Entry point for a "create event", origin : ScreenContextManager ("open" or "use" and not found)

Parameters:
screenContext -
params -
screenSession -
session -
Throws:
TelosysException

eventReuse

public void eventReuse(ScreenContext screenContext,
                       ScreenRequestParameters params,
                       ScreenSession screenSession,
                       DatabaseSession session)
                throws TelosysException
Entry point for a "reuse event", origin : ScreenContextManager ("use" and found)

Parameters:
screenContext -
params -
screenSession -
session -
Throws:
TelosysException