Package de.aeb.xnsg.foundation.bf

Interface IFoundationBF

@BusinessFacade @MTOM @StreamingAttachment(parseEagerly=true, memoryThreshold=1048576L) public interface IFoundationBF
Business facade for the XNSGFoundation

  • Method Details

    • getAllClients

      ClientDTO[] getAllClients()
      Returns all Client's defined in the system. The RFC name of this function is "/AEB/XNSG_IF_CLIENTS"
      Returns:
      Array of ClientDTO objects

    • getAllActiveClients

      ClientDTO[] getAllActiveClients()
      Returns all active Client's defined in the system.
      Returns:
      Array of ClientDTO objects

    • systemSearch

      SystemSearchResultDTO[] systemSearch(SystemSearchParameterDTO[] parameters, String language)
      Searches the engine with the given parameters; Unknown parameters are ignored, valid values of the parameters must be obtained from other documentation. The RFC name of this function is "/AEB/XNSG_IF_SEARCH"
      Returns:
      List of search results

    • getWorkplaceURL

      String getWorkplaceURL()
      Returns the HTTP URL to open the workplace. Typing in the URL in a browser will display a logon mask to the workplace. The RFC name of this function is "/AEB/XNSG_IF_WPURL"
      Returns:
      The HTTP Url to open the workplace

    • getMonitoringValue

      String getMonitoringValue(String groupName, String valueName)
      Returns the current monitoring value for the given group and name

    • getAllMonitoringValues

      MonitoringDataProviderDTO[] getAllMonitoringValues()
      Returns all available monitoring values of the server

    • getProductInfo

      ProductInfoDTO getProductInfo()
      Return information about the server that is answering this request. This includes the product name and various version informations. The RFC name of this function is "/AEB/XNSG_IF_PRINFO"
      Returns:
      information packed in a ProductInfoDTO object

    • getVersionForSolution

      VersionInfoDTO getVersionForSolution(String solutionName)
      Return the version information of a solution that is deployed in the product on this server. The RFC name of this function is "/AEB/XNSG_IF_VERSOL"
      Parameters:
      solutionName - the name of the solution for which version information is to be obtained
      Returns:
      a VersionInfoDTO object containing the requested version, or null if the solution is not deployed to this server, or the argument is null

    • getBuildForSolution

      String getBuildForSolution(String solutionName)
      Return the build information of a solution that is deployed in the product on this server. The RFC name of this function is "/AEB/XNSG_IF_BLDSOL"
      Parameters:
      solutionName - the name of the solution for which version information is to be obtained
      Returns:
      a String object containing the requested version, or null if the solution is not deployed to this server, or the argument is null

    • restartRFCServer

      void restartRFCServer()
      This method is only useful to be called from SAP via RFC. It will restart the RFCServer which receives this method call. This method is useful to be called from SAP, if within SAP some structure definitions had changed, e.g. after installing a transport. The RFC name of this function is "/AEB/XNSG_IF_RSTRFCSRV"

    • getRuntimeInfo

      RuntimeInfoDTO getRuntimeInfo()
      Return runtime information about the server that is answering this request. This includes the server name, ports and various other runtime informations. The RFC name of this function is "/AEB/XNSG_IF_RTINFO"
      Returns:
      information packed in a RuntimeInfoDTO object

    • changeAdminPassword

      ChangeAdminPasswordResultDTO changeAdminPassword(ChangeAdminPasswordParmDTO changeAdminPasswordParmDTO)
      Verify the old password with the old password in the parameter DTO and if its equal then changes the admin password to the new value using AdminPasswordHelper
      Parameters:
      parameter - packed in a ChangeAdminPasswordParmDTO object
      Returns:
      information packed in a ChangeAdminPasswordResultDTO object

    • startTableUpdate

      StartTableUpdateResultDTO startTableUpdate(StartTableUpdateParmDTO startTableUpdateParmDTO)
      Starts the table update, if necessary
      Parameters:
      parameter - packed in a StartTableUpdateParmDTO object
      Returns:
      information packed in a StartTableUpdateResultDTO object

    • getTableUpdateState

      TableUpdateStateResultDTO getTableUpdateState(TableUpdateStateParmDTO tableUpdateStateParmDTO)
      Asks the server for the current state of the table update
      Parameters:
      parameter - packed in a TableUpdateStateParmDTO object
      Returns:
      information packed in a TableUpdateStateResultDTO object

    • announceStop

      AnnounceStopResultDTO announceStop(AnnounceStopParmDTO announceStopParmDTO)
      Announce a stop of the server at a defined time for a defined period
      Parameters:
      parameter - packed in a AnnounceStopParmDTO object
      Returns:
      information packed in a AnnounceStopResultDTO object

    • cancelAnnounceStop

      CancelAnnounceStopResultDTO cancelAnnounceStop(CancelAnnounceStopParmDTO cancelAnnounceStopParmDTO)
      Cancels an announced stop of the server
      Parameters:
      parameter - packed in a CancelAnnounceStopParmDTO object
      Returns:
      information packed in a CancelAnnounceStopResultDTO object

    • sendMail

      SendMailResultDTO sendMail(SendMailParmDTO sendMailParmDTO)
      Sends an email, supports multiple attachments, cc, bcc, etc...
      Parameters:
      sendMailParmDTO - contains the email to sent
      Returns:
      the result of the sendMail method

    • getUploadSettings

      UploadSettingsResponseDTO getUploadSettings(UploadSettingsRequestDTO uploadSettingsRequestDTO)
      Receives information about uploadFile server settings
      Parameters:
      uploadSettingsRequestDTO - Contains information about upload settings
      Returns:
      the settings for uploads

    • uploadFile

      UploadFileResponseDTO uploadFile(UploadFileRequestDTO uploadFileRequestDTO)
      Receives a file for processing on the server. The type of processing is determined by uploadFileRequestDTO and the server configuration.
      Parameters:
      uploadFileRequestDTO - Contains a file and information on how to process it
      Returns:
      the result of the file processing

    • getDownloadableFilesRefs

      DLFilesRefsResponseDTO getDownloadableFilesRefs(DLFilesRefsRequestDTO dLFilesRefsRequestDTO)
      Returns the number of files available for download. The answer depends on the contents of the request and the server configuration.
      Parameters:
      countDownloadableFilesRequestDTO - Contains information on how to select or generate the downloadable files
      Returns:
      the result of request

    • downloadFile

      DownloadFileResponseDTO downloadFile(DownloadFileRequestDTO downloadFileRequestDTO)
      Requests a file for transferring. The origin of the file is determined by the contents of the request and the server configuration.
      Parameters:
      downloadFileRequestDTO - Contains information on how to select or generate the requested file
      Returns:
      the result of the file request

    • acknowledgeFile

      AcknowledgeFileResponseDTO acknowledgeFile(AcknowledgeFileRequestDTO acknowledgeFileRequestDTO)
      Informs the system about a received file. The response is determined by the contents of the request and the server configuration.
      Parameters:
      acknowledgeFileRequestDTO - Contains information as part of which use-case a file was transferred
      Returns:
      the result of the acknowledged file request

    • isDebtorNumberKnown

      boolean isDebtorNumberKnown(String debtorNumber)
      Parameters:
      debtorNumber - to search for
      Returns:
      true, if debtor number was found;
      false otherwise.

    • getNumberOfClients

      int getNumberOfClients()
      Returns:
      number of clients

    • generateClientIdentCode

      String generateClientIdentCode(GenerateClientIdentCodeRequestDTO requestDTO)
      Generates a unique non existing client ident code for the given parameters
      Parameters:
      requestDTO - contains the parameters for the generation, see GenerateClientIdentCodeRequestDTO
      Returns:
      the unique non existing client ident code

    • createClient

      CreateClientResponseDTO createClient(CreateClientRequestDTO requestDTO)
      Create a new client with the given parameters
      Parameters:
      requestDTO - contains the parameters for the creation, see CreateClientRequestDTO
      Returns:
      response dto containing the result state

    • startScriptExecution

      StartScriptExecutionResultDTO startScriptExecution(StartScriptExecutionParmDTO startScriptExecutionParmDTO)
      Start the script execution
      Parameters:
      startScriptExecutionParmDTO - requestDTO contains the parameters for the start, see StartScriptExecutionParmDTO
      Returns:
      response dto containing information about the start, see StartScriptExecutionResultDTO object

    • getScriptExecutionState

      ScriptExecutionStateResultDTO getScriptExecutionState(ScriptExecutionStateParmDTO scriptExecutionStateParmDTO)
      Asks the server for the result of the script execution
      Parameters:
      scriptExecutionStateParmDTO - requestDTO contains the internal id of the script execution, see ScriptExecutionStateParmDTO
      Returns:
      response dto containing information about the execution, see ScriptExecutionStateResultDTO object