com.sabratec.applinx.baseobject

Interface GXIClientBaseObject

All Superinterfaces:

GXIReadOnlyBaseObject

All Known Subinterfaces:

GXINaturalDataTransferClientBaseObject

public interface GXIClientBaseObject
extends GXIReadOnlyBaseObject

This object represents a live session against the ApplinX server and the host. The different methods in the base object session connect to ApplinX server, execute an action on the host and return a response.

Method Summary

Modifier and Type	Method and Description
GXPathResponse	executePath(GXPathRequest request) Executes a path on the host, and returns the response of the path (screens, variables).
GXPathResponse	executePath(String pathName) Executes a path on the host, and returns the response of the path (screens, variables).
GXIProcedureResponse	executeProcedure(GXIExtendedProcedureRequest request) Use this method to execute Procedure Clients generated in the current ApplinX version
GXIProcedureResponse	executeProcedure(GXIProcedureRequest request) Deprecated. Execute the Procedure client with the GXIClientBaseObject.executeProcedure(GXIProcedureRequest, String, String) method, or with the GXIClientBaseObject.executeProcedure(GXIExtendedProcedureRequest) method.
GXIProcedureResponse	executeProcedure(GXIProcedureRequest request, String serviceName, String methodName) Use this method in order to execute Procedure Clients generated in ApplinX version 5.x, 8.0 and 8.1
GXBook[]	getPrints() Gets prints data represented as GXBook(s) print model GXBook
GXITable	getTable() Deprecated. Replaced with GXIClientBaseObject.getScreen().getTable() which returns a table associated with the current screen
GXITable	getTable(GXTableRequest request) Deprecated. Replaced with GXIClientBaseObject.executeProcedure which returns structured data. Refer to the documentation for further details.
GXITable	getTable(String tableName) Deprecated. Replaced with GXIClientBaseObject.executeProcedure which returns structured data.
void	navigateTo(GXNavigateRequest request) Navigates from the current screen to the destination screen using a given map.
void	refreshScreen() Refreshes the current local screen that getScreen() returns with contents from the host.
void	sendKeys(GXSendKeysRequest request) A request that sets input fields, cursor position and sends a key to the host.
void	sendKeys(String key) A request that sends a key to the host.

Methods inherited from interface com.sabratec.applinx.baseobject.GXIReadOnlyBaseObject

getApplicationConfig, getScreen, getScreen, getSeqScreenNumber, getSessionID, isReadOnly

Method Detail

sendKeys

void sendKeys(GXSendKeysRequest request)
       throws GXConnectionException,
              GXGeneralException

A request that sets input fields, cursor position and sends a key to the host. If not host key is specified [enter] is sent to the host.

Parameters:

request - the sendKeys request.

Throws:

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

GXGeneralException - Other errors.

sendKeys

void sendKeys(String key)
       throws GXConnectionException,
              GXGeneralException

A request that sends a key to the host.

Parameters:

key - the host key to send.

Throws:

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

GXGeneralException - Other errors.

executePath

GXPathResponse executePath(GXPathRequest request)
                    throws GXConnectionException,
                           GXPathException,
                           GXGeneralException

Executes a path on the host, and returns the response of the path (screens, variables).

Parameters:

request - the path request.

Returns:

the path's response.

Throws:

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

GXPathException - Errors in path execution.

GXGeneralException - Other errors.

executePath

GXPathResponse executePath(String pathName)
                    throws GXConnectionException,
                           GXPathException,
                           GXGeneralException

Executes a path on the host, and returns the response of the path (screens, variables).

Parameters:

pathName - the name of the path to be executed.

Returns:

the path's response.

Throws:

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

GXPathException - Errors in path execution.

GXGeneralException - Other errors.

executeProcedure

GXIProcedureResponse executeProcedure(GXIProcedureRequest request,
                                      String serviceName,
                                      String methodName)
                               throws GXConnectionException,
                                      GXGeneralException

Use this method in order to execute Procedure Clients generated in ApplinX version 5.x, 8.0 and 8.1

Parameters:

request - the request object of the method. The class is a generated class of procedure client, e.g: <ProcedureName>Request

Returns:

the response object. The class is a generated class of procedure client, e.g: <ProcedureName>Response

Throws:

GXConnectionException

GXGeneralException

executeProcedure

GXIProcedureResponse executeProcedure(GXIProcedureRequest request)
                               throws GXConnectionException,
                                      GXGeneralException

Deprecated. Execute the Procedure client with the GXIClientBaseObject.executeProcedure(GXIProcedureRequest, String, String) method, or with the GXIClientBaseObject.executeProcedure(GXIExtendedProcedureRequest) method.

Parameters:

request - the request object of the method. The class is a generated class of procedure client, e.g: <ProcedureName>Request

Returns:

the response object. The class is a generated class of procedure client, e.g: <ProcedureName>Response

Throws:

GXConnectionException

GXGeneralException

executeProcedure

GXIProcedureResponse executeProcedure(GXIExtendedProcedureRequest request)
                               throws GXConnectionException,
                                      GXGeneralException

Use this method to execute Procedure Clients generated in the current ApplinX version

Parameters:

request - the request object of the method. The class is a generated class of procedure client, e.g: <ProcedureName>Request

Returns:

the response object. The class is a generated class of procedure client, e.g: <ProcedureName>Response

Throws:

GXConnectionException

GXGeneralException

getTable

GXITable getTable(GXTableRequest request)
           throws GXConnectionException,
                  GXGeneralException

Deprecated. Replaced with GXIClientBaseObject.executeProcedure which returns structured data. Refer to the documentation for further details.

This method retrieves a table from ApplinX server according to the GXTableRequest.

Parameters:

request - the table request.

Returns:

the table.

Throws:

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

GXGeneralException - Other errors.

getTable

GXITable getTable(String tableName)
           throws GXConnectionException,
                  GXGeneralException

Deprecated. Replaced with GXIClientBaseObject.executeProcedure which returns structured data.

This method retrieves the path or screen associated table of the specified name from the ApplinX server.

Parameters:

tableName - the table's name as defined in the ApplinX repository.

Returns:

the table.

Throws:

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

GXGeneralException - Other errors.

getTable

GXITable getTable()
           throws GXConnectionException,
                  GXGeneralException

Deprecated. Replaced with GXIClientBaseObject.getScreen().getTable() which returns a table associated with the current screen

This method retrieves a table for the current host screen, if such is defined, including its full details. This is assuming the screen contains only one table in it. If more than one table exists for the screen, no table is returned.

Returns:

the screen's table.

Throws:

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

GXGeneralException - Other errors.

navigateTo

void navigateTo(GXNavigateRequest request)
         throws GXConnectionException,
                GXNavigateException,
                GXGeneralException

Navigates from the current screen to the destination screen using a given map.

Parameters:

request - the navigation request.

Throws:

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

GXNavigateException - Errors in navigation process.

GXGeneralException - Other errors.

refreshScreen

void refreshScreen()
            throws GXConnectionException,
                   GXGeneralException

Refreshes the current local screen that getScreen() returns with contents 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:

GXIReadOnlyBaseObject.getScreen()

getPrints

GXBook[] getPrints()
            throws GXConnectionException,
                   GXGeneralException

Gets prints data represented as GXBook(s) print model GXBook

Returns:

Throws:

GXConnectionException

GXGeneralException