Package de.hybris.platform.sap.core.jco.connection

Interface JCoConnection

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String JCO_DESTINATION
      Property name for destination parameter.
      static java.lang.String JCO_LANG
      Property name for JCo language.
      static java.lang.String JCO_SCOPE_TYPE
      Property name for scope type parameter.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void execute​(com.sap.conn.jco.JCoFunction function)
      This method is used to execute a JCoFunction on behalf of this connection.
      com.sap.conn.jco.JCoFunction getFunction​(java.lang.String functionName)
      Returns a JCoFunction object for the given function name.
      boolean isBackendAvailable()
      Returns true if the backend is available the connection is connected to.
      boolean isBackendOffline()
      Returns true if the backend is switched offline the connection is connected to.
      boolean isFunctionAvailable​(java.lang.String functionName)
      Returns true if the JCo Function is available on the SAP system the connection is connected to.
      void setCallerId​(java.lang.String callerID)
      Sets the caller id.

    • Field Detail

      • JCO_DESTINATION

        static final java.lang.String JCO_DESTINATION
        Property name for destination parameter.
        See Also:
        Constant Field Values

      • JCO_SCOPE_TYPE

        static final java.lang.String JCO_SCOPE_TYPE
        Property name for scope type parameter.
        See Also:
        Constant Field Values

      • JCO_LANG

        static final java.lang.String JCO_LANG
        Property name for JCo language.
        See Also:
        Constant Field Values

    • Method Detail

      • getFunction

        com.sap.conn.jco.JCoFunction getFunction​(java.lang.String functionName)
                                  throws BackendException
        Returns a JCoFunction object for the given function name.
        Parameters:
        functionName - name of remote callable function module on the SAP system
        Returns:
        JCoFunction
        Throws:
        BackendException - when something goes wrong while retrieving meta data

      • execute

        void execute​(com.sap.conn.jco.JCoFunction function)
      throws BackendException
        This method is used to execute a JCoFunction on behalf of this connection.
        Parameters:
        function - a JCoFunction which should be executed
        Throws:
        BackendException - thrown if something goes wrong in the EAI layer or if an JCoException is thrown by the SAP Java Connector.

      • isFunctionAvailable

        boolean isFunctionAvailable​(java.lang.String functionName)
                     throws BackendException
        Returns true if the JCo Function is available on the SAP system the connection is connected to.
        Parameters:
        functionName - function name
        Returns:
        true if the JCo Function is available, otherwise false
        Throws:
        BackendException - BackendException

      • setCallerId

        void setCallerId​(java.lang.String callerID)
        Sets the caller id.
        Parameters:
        callerID - caller id.

      • isBackendAvailable

        boolean isBackendAvailable()
                    throws BackendException
        Returns true if the backend is available the connection is connected to.
        Returns:
        true if the backend is available, otherwise false
        Throws:
        BackendException - BackendException

      • isBackendOffline

        boolean isBackendOffline()
                  throws BackendException
        Returns true if the backend is switched offline the connection is connected to.
        Returns:
        true if the backend is switched offline, otherwise false
        Throws:
        BackendException - BackendException