Interface ReportSelection

    • Method Detail

      • getOperation

        ReportSelectionOperation getOperation()
        Get the value for Operation. (The operation to execute on this selection.) 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.
      • getValue

        String getValue()
        Get the value for Value. (The optional value to compare the LeftReportColumn against.)
        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.
      • setOperation

        void setOperation​(ReportSelectionOperation newOperation)
        Set the value for Operation. (The operation to execute on this selection.) This value is mandatory.
        Parameters:
        newOperation - the new value for Operation. 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.
      • setValue

        void setValue​(String newValue)
        Set the value for Value. (The optional value to compare the LeftReportColumn against.) 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.
      • 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.
      • getLeftReportColumn

        ReportColumn getLeftReportColumn()
        Get the LeftReportColumn.
        Returns:
        LeftReportColumn
        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.
      • getRightReportColumn

        ReportColumn getRightReportColumn()
        Get the RightReportColumn.
        Returns:
        RightReportColumn
        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.
      • getJobDefinitionParameter

        JobDefinitionParameter getJobDefinitionParameter()
        Get the JobDefinitionParameter.
        Returns:
        JobDefinitionParameter
        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.
      • setLeftReportColumn

        void setLeftReportColumn​(ReportColumn newLeftReportColumn)
        Set the value for LeftReportColumn. This value is mandatory.
        Parameters:
        newLeftReportColumn - is the object to set LeftReportColumn to. The left hand ReportColumn of this ReportSelection operation. If this is null, then the object cannot be persisted.
      • setRightReportColumn

        void setRightReportColumn​(ReportColumn newRightReportColumn)
        Set the value for RightReportColumn. This value is optional.
        Parameters:
        newRightReportColumn - is the object to set RightReportColumn to. The right hand ReportColumn of this ReportSelection operation.
      • setJobDefinitionParameter

        void setJobDefinitionParameter​(JobDefinitionParameter newJobDefinitionParameter)
        Set the value for JobDefinitionParameter. This value is optional.
        Parameters:
        newJobDefinitionParameter - is the object to set JobDefinitionParameter to. The right hand ReportColumn of this ReportSelection operation.