com.sabratec.applinx.baseobject

Interface GXIReadOnlyBaseObject

All Known Subinterfaces:

GXIClientBaseObject, GXINaturalDataTransferClientBaseObject

public interface GXIReadOnlyBaseObject

This object represents a live session against the ApplinX server and the host, in Read-Only mode, i.e. only monitoring the session is permitted.

See Also:

GXIClientBaseObject

Method Summary

Modifier and Type	Method and Description
GXClientApplicationConfig	getApplicationConfig() Returns the current application configuration.
GXIScreen	getScreen() Returns the current screen from the host.
GXIScreen	getScreen(GXGetScreenRequest request) Returns the current screen from the host.
int	getSeqScreenNumber() returns the sequential number of the host screen in the server (counted since the session started).
String	getSessionID()
boolean	isReadOnly() Return whether this client has a write access, or only a read-only access.

Method Detail

getScreen

GXIScreen getScreen(GXGetScreenRequest request)
             throws GXConnectionException,
                    GXGeneralException

Returns the current screen from the host. May also execute wait conditions before retrieving it. If it is called without a request object and if no other request was sent to the host since the last time getScreen was called, it returns a local copy of the last retrieved screen.

Parameters:

request - the getScreen request.

Returns:

the current screen from the host.

Throws:

GXConnectionException - When connection problems occurred between the client and ApplinX server or the ApplinX server and the host.

GXGeneralException - Other errors.

See Also:

getScreen()

getScreen

GXIScreen getScreen()
             throws GXConnectionException,
                    GXGeneralException

Returns the current screen from the host. May also execute wait conditions before retrieving it. When called without a request object and if no other request was sent to the host since the last time getScreen was called, it returns a local copy of the last retrieved screen.

Returns:

a local copy of the last retrieved screen.

Throws:

GXConnectionException - When connection problems occurred between the client and ApplinX server or the ApplinX server and the host.

GXGeneralException - Other errors.

getSeqScreenNumber

int getSeqScreenNumber()
                throws GXConnectionException,
                       GXGeneralException

returns the sequential number of the host screen in the server (counted since the session started).

Returns:

the sequential screen number.

Throws:

GXConnectionException - When connection problems occurred between the client and ApplinX server or the ApplinX server and the host.

GXGeneralException - Other errors.

getSessionID

String getSessionID()

Returns:

the ID of the session on ApplinX Server.

getApplicationConfig

GXClientApplicationConfig getApplicationConfig()
                                        throws GXConnectionException,
                                               GXGeneralException

Returns the current application configuration. The first time this method is called, a request will be sent to the server to retrieve the information. Sequential calls to this method will return the same configuration (additional requests will not be sent to the server).
Note that when the application configuration is changed on the server, the way to retrieve the updated information is to create a new BaseObject and call this method again.

Throws:

GXConnectionException - When connection problems occurred between the client and ApplinX server or the ApplinX server and the host.

GXGeneralException - Other errors.

isReadOnly

boolean isReadOnly()

Return whether this client has a write access, or only a read-only access.