com.sabratec.applinx.baseobject

Interface GXINaturalDataTransferClientBaseObject

All Superinterfaces:

GXIClientBaseObject, GXIReadOnlyBaseObject

public interface GXINaturalDataTransferClientBaseObject
extends GXIClientBaseObject

This object is an extension of the GXIClientBaseObject that provides the option to perform Natural Data Transfer (NDT) actions.

Method Summary

Modifier and Type	Method and Description
void	confirmCommand() Confirm the execution of a Natural Data Transfer command.
GXNaturalDataTransferDownloadResponse	continueDownload() Continues the download process.
GXNaturalDataTransferUploadResponse	continueUpload() Continues the process of uploading a file.
void	rejectTransfer() Sends an indication to the host that a transfer process should be rejected.
GXNaturalDataTransferDownloadResponse	startDownload(GXNaturalDataTransferDownloadRequest request) Starts the download process.
GXNaturalDataTransferUploadResponse	startUpload(GXNaturalDataTransferUploadRequest request) Starts the process of uploading a file.

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

executePath, executePath, executeProcedure, executeProcedure, executeProcedure, getPrints, getTable, getTable, getTable, navigateTo, refreshScreen, sendKeys, sendKeys

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

getApplicationConfig, getScreen, getScreen, getSeqScreenNumber, getSessionID, isReadOnly

Method Detail

startDownload

GXNaturalDataTransferDownloadResponse startDownload(GXNaturalDataTransferDownloadRequest request)
                                             throws GXConnectionException,
                                                    GXNaturalDataTransferException,
                                                    GXGeneralException

Starts the download process. The server will download a file from the host, and will return it when it has been fully downloaded.
Note that this method may return before the download is completed.

Parameters:

fileType - Type of downloaded file. Supported types:

• com.sabratec.emulation_common.ntc.GXNaturalDataTransferConsts#FORMAT_TYPE_TXT
• com.sabratec.emulation_common.ntc.GXNaturalDataTransferConsts#FORMAT_TYPE_CSV

Throws:

GXNaturalDataTransferException - when there was a problem with the data transfer

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

GXGeneralException - when there is a general problem

continueDownload

GXNaturalDataTransferDownloadResponse continueDownload()
                                                throws GXConnectionException,
                                                       GXNaturalDataTransferException,
                                                       GXGeneralException

Continues the download process. The server will continue a previous download from the host, and will return the download data only if the download process was completed. This method may be called only after calling #startDownload().
Note that this method may return before the download is completed.

Throws:

GXNaturalDataTransferException - if there is a problem with the data transfer

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

GXGeneralException - if there is a general problem

startUpload

GXNaturalDataTransferUploadResponse startUpload(GXNaturalDataTransferUploadRequest request)
                                         throws GXConnectionException,
                                                GXNaturalDataTransferException,
                                                GXGeneralException

Starts the process of uploading a file. The server will upload a file to the host.
Note that this method may return before the upload is completed.

Parameters:

request - the upload request details

Throws:

GXNaturalDataTransferException - if there is a problem with the data transfer

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

GXGeneralException - if there is a general problem

continueUpload

GXNaturalDataTransferUploadResponse continueUpload()
                                            throws GXConnectionException,
                                                   GXNaturalDataTransferException,
                                                   GXGeneralException

Continues the process of uploading a file. The server will upload a previously given file to the host. This method may be called only after calling #startUpload(InputStream).
Note that this method may return before the upload is completed.

Throws:

GXNaturalDataTransferException - if there is a problem with the data transfer

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

GXGeneralException - if there is a general problem

rejectTransfer

void rejectTransfer()
             throws GXConnectionException,
                    GXNaturalDataTransferException,
                    GXGeneralException

Sends an indication to the host that a transfer process should be rejected. It applies for both upload, download and a command.

Throws:

GXNaturalDataTransferException - if there is a problem with the data transfer

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

GXGeneralException - if there is a general problem

confirmCommand

void confirmCommand()
             throws GXConnectionException,
                    GXNaturalDataTransferException,
                    GXGeneralException

Confirm the execution of a Natural Data Transfer command.
When the command is an asynchronous command, the confirmation should be sent after the command execution started successfully.
When the command is a synchronous command, the confirmation should be sent only after the command execution finished successfully.

Throws:

GXNaturalDataTransferException - if there is a problem with the data transfer

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

GXGeneralException - if there is a general problem