Interface WebScheduleTriggerTime

    • Method Detail

      • isTriggerRepeatable

        boolean isTriggerRepeatable()
        Returns whether this trigger will fire repeatedly throughout the trigger day
        Returns:
        boolean value specifying whether this trigger will fire multiple times on the trigger day
      • enableTriggerRepeat

        void enableTriggerRepeat​(int type,
                                 int value)
        Deprecated.
        Enables the trigger to fire multiple times on the trigger day
        Parameters:
        type - int specifying whether the time between same day firings will be measured in hours or minutes. See: TypeHour and TypeMinute
        value - int specifying the number of hours or minutes between same day firings. Must be between 1 and 23 for hours.
      • enableTriggerRepeat

        void enableTriggerRepeat​(int value)
        Enables the trigger to fire multiple times on the trigger day
        Parameters:
        value - int specifying the number of minutes between same day firings
      • disableTriggerRepeat

        void disableTriggerRepeat()
        Prevents the trigger from firing multiple times on a trigger day
      • getTriggerTime

        java.lang.String getTriggerTime()
        Returns text specifying the 24-hour time that the trigger will fire once. NOTE: The returned string is meaningless if TriggerRepeat is enabled
        Returns:
        String containing the 24-hour time that the trigger will fire once
      • setTriggerTime

        void setTriggerTime​(java.lang.String time)
        Sets the time at which the trigger will fire once. NOTE: Disables TriggerRepeat
        Parameters:
        time - String containing time in either 12-hour (hh:mm:ss ?M) or 24-hour (hh:mm:ss) format
      • getRepeatValue

        int getRepeatValue()
        Returns the number of minutes between same day firings
        Returns:
        int value specifying the number of minutes between same day firings
      • getRepeatValueType

        int getRepeatValueType()
        Deprecated.
        This interface only supports TypeMinute as of 2009.05.07
        Returns the type specifying how the repeat value is to be interpretted
        Returns:
        int specifying how the repeat value is to be interpretted (either TypeHour or TypeMinute)
      • getMinutesAfterMidnight

        int getMinutesAfterMidnight()
        Deprecated.
        Returns the minutes after midnight that this trigger will begin firing. Meaningless if TriggerRepeat is false or if RepeatValue is of type TypeMinute
        Returns:
        int number of minutes after midnight that this trigger will begin firing
      • setMinutesAfterMidnight

        void setMinutesAfterMidnight​(int minutes)
        Deprecated.
        Sets the number of minutes after midnight that the trigger will begin firing. Action ignored if TriggerRepeat is false or if RepeatValue is of type TypeMinute
        Parameters:
        minutes - int number of minutes
      • getRepeatStart

        int getRepeatStart()
        Returns the number of seconds after midnight that this trigger will begin repeat firing. Meaningless if isTriggerRepeatable() returns false
        Returns:
        int number of seconds after midnight to being repeat firing
      • setRepeatStart

        void setRepeatStart​(int seconds)
        Sets the number of seconds after midnight that the trigger will begin repeat firing. Only pertinent if TriggerRepeat is enabled.
        Parameters:
        seconds - int number of seconds after midnight to begin repeat firing
      • getRepeatStop

        int getRepeatStop()
        Returns the number of seconds after midnight that this trigger will end repeat firing. Meaningless if isTriggerRepeatable() returns false
        Returns:
        int number of seconds after midnight to end repeat firing
      • setRepeatStop

        void setRepeatStop​(int seconds)
        Sets the number of seconds after midnight that this trigger will end repeat firing. Only pertinent off TriggerRepeat is enabled
        Parameters:
        seconds - int number of seconds after midnight to end repeat firing
      • getTriggerSubType

        int getTriggerSubType()
        Returns the subtype of a time trigger
        Returns:
        int specifying the type of time trigger this is. Must be one of daily, weekly, monthly, yearly, undefined