Interface SAPJ2EEClient

    • Method Detail

      • getDescription

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

        SAPJ2EEClientType getType()
        Get the value for Type. (Type of the J2EE client.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isEnabled

        boolean isEnabled()
        Get the value for Enabled. (Whether this client definition is active or not.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.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 J2EE interface version.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.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:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setType

        void setType​(SAPJ2EEClientType newType)
        Set the value for Type. (Type of the J2EE client.) This value is mandatory.
        Parameters:
        newType - the new value for Type. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.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:
        com.redwood.scheduler.api.exception.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 J2EE interface version.) This value is optional.
        Parameters:
        newInterfaceVersion - the new value for InterfaceVersion.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • checkConnectionSettings

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

        SAPSystem getSAPSystem()
        Get the SAPSystem.
        Returns:
        SAPSystem
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.