Interface LoadFactor

    • Field Detail

      • VERSION_LOADFACTOR

        static final com.redwood.scheduler.infrastructure.logging.Versions VERSION_LOADFACTOR
    • Method Detail

      • getDescription

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

        Long getMultiplier()
        Get the value for Multiplier. (The multiplier to apply to the load factor.) 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.
      • getThreshold

        Long getThreshold()
        Get the value for Threshold. (The maximum threshold this factor can reach before marking as overloaded.) 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.
      • setDescription

        void setDescription​(String newDescription)
        Set the value for Description. (The (optional) description of the load factor) 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.
      • setMultiplier

        void setMultiplier​(Long newMultiplier)
        Set the value for Multiplier. (The multiplier to apply to the load factor.) This value is mandatory.
        Parameters:
        newMultiplier - the new value for Multiplier. 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.
      • setThreshold

        void setThreshold​(Long newThreshold)
        Set the value for Threshold. (The maximum threshold this factor can reach before marking as overloaded.) This value is mandatory.
        Parameters:
        newThreshold - the new value for Threshold. 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.
      • isOverloaded

        boolean isOverloaded()
        Return if the LoadFactor is currently overloaded or not. Return if the LoadFactor is currently overloaded or not.
        Returns:
        The overloaded status of the LoadFactor.
      • setMonitorValue

        void setMonitorValue​(MonitorValue newMonitorValue)
        Set the value for MonitorValue. This value is mandatory.
        Parameters:
        newMonitorValue - is the object to set MonitorValue to. The monitor value to listen to for changes in this factor. If this is null, then the object cannot be persisted.