com.goldencode.p2j.ui.client.gui.driver

Interface EmbeddedClient

All Known Implementing Classes:

GuiWebDriver

public interface EmbeddedClient

This interface needs to be implemented by drivers for which clients can run in an embedded mode. It defines the APIs which can be used by these clients.

Method Summary

Modifier and Type	Method and Description
void	clearMessages(int windowId) Clear all message texts of specified window.
boolean	isEmbeddedClient() Returns true if this client runs in embedded mode.
void	publish(long subId, java.lang.String event, java.lang.String[] param) Send a PUBLISH notification to a remote application.
UnformattedPayload	remoteCall(UnformattedPayload request) This is a special API which is used to delegate a call from converted 4GL code (via _P2J_REMOTE_CALL_ functions) to the remote side.
void	setMessageText(int windowId, java.lang.String[] message) Add message texts of specified window.
void	setStatusText(int windowId, java.lang.String message) Set status text message of specified window.

Method Detail

isEmbeddedClient

boolean isEmbeddedClient()

Returns true if this client runs in embedded mode.

Returns:

See above.

remoteCall

UnformattedPayload remoteCall(UnformattedPayload request)

This is a special API which is used to delegate a call from converted 4GL code (via _P2J_REMOTE_CALL_ functions) to the remote side. Usually, this is used when P2J client runs in embedded mode, i.e. the P2J screens are embedded in another customer-specific application. The call will be remoted into the customer-specific application.

This API is expected to block waiting for a response.

Parameters:

request - The request data incoming from 4GL.

Returns:

The response from the customer-specific application, which will be sent back to the converted 4GL code.

publish

void publish(long subId,
             java.lang.String event,
             java.lang.String[] param)

Send a PUBLISH notification to a remote application.

Parameters:

subId - The subscriber's ID, known by the remote application.

event - The published event name.

param - The parameters for this event.

setStatusText

void setStatusText(int windowId,
                   java.lang.String message)

Set status text message of specified window.

Parameters:

windowId - Window ID.

message - Text message.

setMessageText

void setMessageText(int windowId,
                    java.lang.String[] message)

Add message texts of specified window.

Parameters:

windowId - Window ID.

message - Text message.

clearMessages

void clearMessages(int windowId)

Clear all message texts of specified window.

Parameters:

windowId - Window ID.