Interface JCoRequest

All Superinterfaces:
Cloneable, Iterable<JCoField>, JCoParameterList, JCoRecord, Serializable

public interface JCoRequest extends JCoParameterList
A JCoRequest is a special view on a JCoFunction and is used in the Request/Response model of JCo function calls. It contains all parameters of a function that are inputs to a function call, the import, changing, and table parameters.
  • Method Details

    • getExceptionList

      AbapException[] getExceptionList()
      Returns the ABAP exception list.
      Returns:
      the ABAP exception list or null if none is defined
    • getException

      AbapException getException(String key)
      Returns the ABAP exception for the specified key.
      Parameters:
      key - the key for the exception as specified in the function interface
      Returns:
      the ABAP exception for the specified key or null
    • execute

      JCoResponse execute(JCoDestination destination) throws JCoException
      Executes the request on the given target destination synchronously using the RFC protocol.
      Parameters:
      destination - the destination on which the request should be executed
      Returns:
      the response object containing the result of the request execution
      Throws:
      JCoException - if an exception occurred during the call execution
      See Also:
    • execute

      void execute(JCoDestination destination, String tid) throws JCoException
      Executes the request on the given target destination in transactional mode using the tRfc protocol.
      Parameters:
      destination - the destination on which the request should be executed
      tid - the transaction ID to use for the tRFC call
      Throws:
      JCoException - if an exception occurred during the call execution
      Since:
      JCo 3.1.7
    • execute

      void execute(JCoDestination destination, String tid, String queueName) throws JCoException
      Executes the request on the given target destination in queued transactional mode using the qRfc protocol.
      Parameters:
      destination - the destination on which the request should be executed
      tid - the transaction ID to use for the qRFC call
      queueName - the inbound queue to use for the qRFC call
      Throws:
      JCoException - if an exception occurred during the call execution
      Since:
      JCo 3.1.7
    • getName

      String getName()
      Returns the name of the function module that is referred to by the JCoRequest.
      Returns:
      the name of the function module
    • setAbapClassExceptionMode

      void setAbapClassExceptionMode(AbapClassException.Mode mode)
      Sets the mode for ABAP class exceptions. Enabling means the ABAP server is permitted to transmit an ABAP class exception, whereas disabling signifies that the server must not transmit such an exception.
      Parameters:
      mode - the value determining whether ABAP class exceptions are permitted (full or limited to the exception chain) or not
    • isAbapClassExceptionEnabled

      boolean isAbapClassExceptionEnabled()
      Returns the boolean value that indicates whether or not the server is permitted to transmit an ABAP class exception when executing this request.
      Returns:
      true or false depending on whether transmitting ABAP class exceptions is permitted or not, respectively