Interface ReportColumn

    • Method Detail

      • isDisplay

        boolean isDisplay()
        Get the value for Display. (Whether this column is displayed or not. Defaults to true.)
        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.
      • getColumnFormat

        ReportColumnFormat getColumnFormat()
        Get the value for ColumnFormat. (The format for the column.)
        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.
      • getValue

        String getValue()
        Get the value for Value. (The Query Column value or an Expression for determining the column value)
        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.
      • getColumnOrder

        Long getColumnOrder()
        Get the value for ColumnOrder. (The ordered position of the column.) 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.
      • setDisplay

        void setDisplay​(boolean newDisplay)
        Set the value for Display. (Whether this column is displayed or not. Defaults to true.)
        Parameters:
        newDisplay - the new value for Display.
        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.
      • setColumnFormat

        void setColumnFormat​(ReportColumnFormat newColumnFormat)
        Set the value for ColumnFormat. (The format for the column.) This value is optional.
        Parameters:
        newColumnFormat - the new value for ColumnFormat.
        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.
      • setValue

        void setValue​(String newValue)
        Set the value for Value. (The Query Column value or an Expression for determining the column value) This value is optional.
        Parameters:
        newValue - the new value for Value.
        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.
      • setColumnOrder

        void setColumnOrder​(Long newColumnOrder)
        Set the value for ColumnOrder. (The ordered position of the column.) This value is mandatory.
        Parameters:
        newColumnOrder - the new value for ColumnOrder. 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.
      • getReport

        Report getReport()
        Get the Report.
        Returns:
        Report
        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.