com.servoy.j2db.server.headlessclient
Interface IHeadlessClient

All Known Subinterfaces:

ISessionBean

public interface IHeadlessClient

Method Summary

String	getClientID() Gets the clientId of this client.
Object	getDataProviderValue(String contextName, String dataprovider) Get a dataprovider value.
IClientPluginAccess	getPluginAccess() Get the plugin access, for more functionality.
boolean	isValid() Check if the client still valid for usage.
Object	setDataProviderValue(String contextName, String dataprovider, Object value) Set a dataprovider value.
void	shutDown(boolean force) Shut down this client

Method Detail

getClientID

String getClientID()

Gets the clientId of this client.

Returns:

A String which holds the id of the client.

getDataProviderValue

Object getDataProviderValue(String contextName,
                            String dataprovider)

Get a dataprovider value.

Parameters:

context - This is the form name or null if the method is a global method.

dataprovider - the dataprovider name as seen in Servoy

Returns:

the value for the dataprovider

getPluginAccess

IClientPluginAccess getPluginAccess()

Get the plugin access, for more functionality.

Returns:

the plugin access

isValid

boolean isValid()

Check if the client still valid for usage.

setDataProviderValue

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

Set a dataprovider value.

Parameters:

context - This is the form name or null if the method is a global method.

dataprovider - the dataprovider name as seen in Servoy

value - to set

Returns:

the old value or null if no change

shutDown

void shutDown(boolean force)

Shut down this client

Parameters:

force - to enforce shutdown