com.servoy.j2db.server.headlessclient
Interface ISessionBean

All Superinterfaces:

EventListener, javax.servlet.http.HttpSessionBindingListener

public interface ISessionBean
extends javax.servlet.http.HttpSessionBindingListener

Interface to interact with a client from within a JSP page

 
        ISessionBean servoy_hc = (ISessionBean)session.getAttribute("servoy");
        if (servoy_hc == null)
        {
                //args are solution name,username,password 
                servoy_hc = HeadlessClientFactory.createSessionBean(request,"headless_client_demo");
                session.setAttribute("servoy",servoy_hc);
        }
        //servoy_hc is now usable...
 

Sample contextName values:
1) null, main form foundset
2) "forms.<xxxxx>", for tabpanel relationless form foundset

See Also:

HeadlessClientFactory

Method Summary

Object	executeMethod(String visibleFormName, String methodName, Object[] arguments) Execute a form or global method.
Object	getDataProviderValue(String contextName, String dataprovider) Get a dataprovider value.
String	getI18NMessage(String key, Object[] args) Get a message for a key and optional arguments
IDataSet	getValueListItems(String contextName, String valuelistName) Get valuelist items as dataset.
void	saveData() Save all the data set via the setData methods.
Object	setDataProviderValue(String contextName, String dataprovider, Object value) Set a dataprovider value.
int	setDataProviderValues(String contextName, javax.servlet.http.HttpServletRequest request_data) Set all request parameters as dataprovider values, if the names match.
void	setLocale(Locale l) Override the default used browser locale
boolean	setMainForm(String formName) Sets a form as main form.

Methods inherited from interface javax.servlet.http.HttpSessionBindingListener

valueBound, valueUnbound

Method Detail

executeMethod

Object executeMethod(String visibleFormName,
                     String methodName,
                     Object[] arguments)
                     throws Exception

Execute a form or global method.

Parameters:

visibleFormName - the name of the form (must be visible)

methodName - the name of the method to call

arguments - to pass to the method

Returns:

the value returned by the method

Throws:

Exception

getDataProviderValue

Object getDataProviderValue(String contextName,
                            String dataprovider)

Get a dataprovider value.

Parameters:

contextName - the context for this request

dataprovider - the dataprovider name as seen in Servoy

Returns:

the value for the dataprovider

getI18NMessage

String getI18NMessage(String key,
                      Object[] args)

Get a message for a key and optional arguments

Parameters:

key -

args -

Returns:

the text

getValueListItems

IDataSet getValueListItems(String contextName,
                           String valuelistName)

Get valuelist items as dataset.

Parameters:

contextName - the context for this request

valuelistName - the name from the valuelist

Returns:

the dataset with valuelist values

saveData

void saveData()

Save all the data set via the setData methods.

setDataProviderValue

Object setDataProviderValue(String contextName,
                            String dataprovider,
                            Object value)

Set a dataprovider value.

Parameters:

contextName - the context for this request

dataprovider - the dataprovider name as seen in Servoy

value - to set

Returns:

the old value or null if no change

setDataProviderValues

int setDataProviderValues(String contextName,
                          javax.servlet.http.HttpServletRequest request_data)

Set all request parameters as dataprovider values, if the names match.

Parameters:

contextName - the context for this request

request_data - the page request object

setLocale

void setLocale(Locale l)

Override the default used browser locale

Parameters:

l -

setMainForm

boolean setMainForm(String formName)

Sets a form as main form.

Parameters:

formName - the name of the form to set as main form

Returns:

true if successful