Interface SAPCommonSettings

    • Method Detail

      • isEnabled

        boolean isEnabled()
        Get the value for Enabled. (Whether this client definition is active or not.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getAuditLevel

        Long getAuditLevel()
        Get the value for AuditLevel. (Audit level of SAP interface.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getClientNumber

        String getClientNumber()
        Get the value for ClientNumber. (Client number for SAP interface.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getDescription

        String getDescription()
        Get the value for Description. (The description of this step)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getInterfaceVersion

        String getInterfaceVersion()
        Get the value for InterfaceVersion. (SAP interface version.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getSAPLanguage

        String getSAPLanguage()
        Get the value for SAPLanguage. (SAP language.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getMaximumNumberOfRFCConnections

        Long getMaximumNumberOfRFCConnections()
        Get the value for MaximumNumberOfRFCConnections. (Maximum number of RFC connections.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setEnabled

        void setEnabled​(boolean newEnabled)
        Set the value for Enabled. (Whether this client definition is active or not.)
        Parameters:
        newEnabled - the new value for Enabled.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setAuditLevel

        void setAuditLevel​(Long newAuditLevel)
        Set the value for AuditLevel. (Audit level of SAP interface.) This value is mandatory.
        Parameters:
        newAuditLevel - the new value for AuditLevel. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setClientNumber

        void setClientNumber​(String newClientNumber)
        Set the value for ClientNumber. (Client number for SAP interface.) This value is mandatory.
        Parameters:
        newClientNumber - the new value for ClientNumber. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setDescription

        void setDescription​(String newDescription)
        Set the value for Description. (The description of this step) This value is optional.
        Parameters:
        newDescription - the new value for Description.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setInterfaceVersion

        void setInterfaceVersion​(String newInterfaceVersion)
        Set the value for InterfaceVersion. (SAP interface version.) This value is optional.
        Parameters:
        newInterfaceVersion - the new value for InterfaceVersion.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setSAPLanguage

        void setSAPLanguage​(String newSAPLanguage)
        Set the value for SAPLanguage. (SAP language.) This value is mandatory.
        Parameters:
        newSAPLanguage - the new value for SAPLanguage. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setMaximumNumberOfRFCConnections

        void setMaximumNumberOfRFCConnections​(Long newMaximumNumberOfRFCConnections)
        Set the value for MaximumNumberOfRFCConnections. (Maximum number of RFC connections.) This value is optional.
        Parameters:
        newMaximumNumberOfRFCConnections - the new value for MaximumNumberOfRFCConnections.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • checkConnectionSettings

        String checkConnectionSettings()
        Check the client number, username and password attributes for validity.
        Returns:
        Return null when client number, username and password are valid, error message otherwise.
      • isSNCConnection

        boolean isSNCConnection()
        Check if the connection is using SNC.
        Returns:
        true if the connection is using SNC, false otherwise