Interface DashboardItem

    • Method Detail

      • getFullConfiguration

        String getFullConfiguration()
        Get the value for FullConfiguration. (The full configuration of the widget. This is a property file.) 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.
      • getNumAdditionalLines

        Long getNumAdditionalLines()
        Get the value for NumAdditionalLines. (The number of additional lines for the configuration.) 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.
      • setFullConfiguration

        void setFullConfiguration​(String newFullConfiguration)
        Set the value for FullConfiguration. (The full configuration of the widget. This is a property file.) This value is mandatory.
        Parameters:
        newFullConfiguration - the new value for FullConfiguration. 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.
      • getDashboard

        Dashboard getDashboard()
        Get the Dashboard.
        Returns:
        Dashboard
        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.