Interface SubmitFrameElement

    • Method Detail

      • getDescription

        String getDescription()
        Get the value for Description. (Optional description)
        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.
      • getEveryNumberOf

        Long getEveryNumberOf()
        Get the value for EveryNumberOf. (The cycle in seconds, minutes, days or months. The unit of measure is specified in the Unit field. )
        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.
      • getUnit

        TimeUnit getUnit()
        Get the value for Unit. (The unit of measure.)
        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.
      • getStartTime

        Long getStartTime()
        Get the value for StartTime. (The explicitly defined base start time (in milliseconds from the start of the day).)
        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.
      • isMustFitTimeWindow

        boolean isMustFitTimeWindow()
        Get the value for MustFitTimeWindow. (Should the element fit the TimeWindow or can we slide forward to the nearest TimeWindow opening?)
        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.
      • isPreserveTimes

        boolean isPreserveTimes()
        Get the value for PreserveTimes. (Eleminate daylight saving times, so the jobs of such submitframe always run at the same time each day)
        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.
      • setDescription

        void setDescription​(String newDescription)
        Set the value for Description. (Optional description) This value is optional.
        Parameters:
        newDescription - the new value for Description.
        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.
      • setEveryNumberOf

        void setEveryNumberOf​(Long newEveryNumberOf)
        Set the value for EveryNumberOf. (The cycle in seconds, minutes, days or months. The unit of measure is specified in the Unit field. ) This value is optional.
        Parameters:
        newEveryNumberOf - the new value for EveryNumberOf.
        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.
      • setUnit

        void setUnit​(TimeUnit newUnit)
        Set the value for Unit. (The unit of measure.) This value is optional.
        Parameters:
        newUnit - the new value for Unit.
        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.
      • setStartTime

        void setStartTime​(Long newStartTime)
        Set the value for StartTime. (The explicitly defined base start time (in milliseconds from the start of the day).) This value is optional.
        Parameters:
        newStartTime - the new value for StartTime.
        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.
      • setMustFitTimeWindow

        void setMustFitTimeWindow​(boolean newMustFitTimeWindow)
        Set the value for MustFitTimeWindow. (Should the element fit the TimeWindow or can we slide forward to the nearest TimeWindow opening?)
        Parameters:
        newMustFitTimeWindow - the new value for MustFitTimeWindow.
        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.
      • setPreserveTimes

        void setPreserveTimes​(boolean newPreserveTimes)
        Set the value for PreserveTimes. (Eleminate daylight saving times, so the jobs of such submitframe always run at the same time each day)
        Parameters:
        newPreserveTimes - the new value for PreserveTimes.
        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.
      • getSubmitFrame

        SubmitFrame getSubmitFrame()
        Get the SubmitFrame.
        Returns:
        SubmitFrame
        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.
      • getDuringTimeWindow

        TimeWindow getDuringTimeWindow()
        Get the DuringTimeWindow.
        Returns:
        DuringTimeWindow
        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.
      • getStartTimeZone

        TimeZone getStartTimeZone()
        Get the StartTimeZone.
        Returns:
        StartTimeZone
        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.
      • setDuringTimeWindow

        void setDuringTimeWindow​(TimeWindow newDuringTimeWindow)
        Set the value for DuringTimeWindow. This value is optional.
        Parameters:
        newDuringTimeWindow - is the object to set DuringTimeWindow to. A time window during which the submit frame interval can generate submits
      • setStartTimeZone

        void setStartTimeZone​(TimeZone newStartTimeZone)
        Set the value for StartTimeZone. This value is optional.
        Parameters:
        newStartTimeZone - is the object to set StartTimeZone to. Which TimeZone will be used for the start time of the submit frame element.