Interface VisualizationPSQProcessServer

    • Method Detail

      • isVisible

        boolean isVisible()
        Get the value for Visible. (Show this process server in the visualization.)
        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.
      • getLeftPosition

        BigDecimal getLeftPosition()
        Get the value for LeftPosition. (The left position of the process server.)
        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.
      • getTopPosition

        BigDecimal getTopPosition()
        Get the value for TopPosition. (The top position of the process server.)
        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.
      • getMaxLoad

        BigDecimal getMaxLoad()
        Get the value for MaxLoad. (The maximum load of the process server.) 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.
      • setVisible

        void setVisible​(boolean newVisible)
        Set the value for Visible. (Show this process server in the visualization.)
        Parameters:
        newVisible - the new value for Visible.
        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.
      • setLeftPosition

        void setLeftPosition​(BigDecimal newLeftPosition)
        Set the value for LeftPosition. (The left position of the process server.) This value is optional.
        Parameters:
        newLeftPosition - the new value for LeftPosition.
        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.
      • setTopPosition

        void setTopPosition​(BigDecimal newTopPosition)
        Set the value for TopPosition. (The top position of the process server.) This value is optional.
        Parameters:
        newTopPosition - the new value for TopPosition.
        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.
      • setMaxLoad

        void setMaxLoad​(BigDecimal newMaxLoad)
        Set the value for MaxLoad. (The maximum load of the process server.) This value is mandatory.
        Parameters:
        newMaxLoad - the new value for MaxLoad. 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.
      • getVisualizationProcessServerQueue

        VisualizationProcessServerQueue getVisualizationProcessServerQueue()
        Get the VisualizationProcessServerQueue.
        Returns:
        VisualizationProcessServerQueue
        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.
      • getProcessServer

        ProcessServer getProcessServer()
        Get the ProcessServer.
        Returns:
        ProcessServer
        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.
      • setProcessServer

        void setProcessServer​(ProcessServer newProcessServer)
        Set the value for ProcessServer. This value is mandatory.
        Parameters:
        newProcessServer - is the object to set ProcessServer to. The process server If this is null, then the object cannot be persisted.