Package com.uc4.api.objects

Class EventSettings

java.lang.Object
com.uc4.api.objects.EventSettings
public class EventSettings extends Object
This class represents the "Event" tab of an Event object.

  • Constructor Details

    • EventSettings

      protected EventSettings(com.uc4.util.XMLDocument doc)

  • Method Details

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element request)

    • isExecuteAfterScheduledTime

      public boolean isExecuteAfterScheduledTime()
      Returns:
      True if the event should be started after the scheduled time

    • setExecuteAfterScheduledTime

      public void setExecuteAfterScheduledTime(boolean executeAfterScheduledTime)
      Defines if the event should start after the scheduled time.
      Parameters:
      executeAfterScheduledTime - True if the event should be started after the scheduled time

    • isFirstExecutionAfterExpire

      public boolean isFirstExecutionAfterExpire()
      Returns:
      True if the first execution should be done after time is expired

    • isFirstExecutionImmediately

      public boolean isFirstExecutionImmediately()
      Returns:
      True if the first execution should be done immediately

    • setFirstExecutionImmediately

      public void setFirstExecutionImmediately()
      Sets the first execution immediately.

    • setFirstExecutionAfterExpire

      public void setFirstExecutionAfterExpire()
      Sets the first execution after time is expired .

    • setExecutionTypeRepeated

      public void setExecutionTypeRepeated()
      Sets the execution type to repeated.

    • isExecutionTypeRepeated

      public boolean isExecutionTypeRepeated()
      Returns:
      True if the execution type is repeated

    • setExecutionTypeSingle

      public void setExecutionTypeSingle()
      Sets the execution type to single.

    • isExecutionTypeSingle

      public boolean isExecutionTypeSingle()
      Returns:
      True if the execution type is set to single

    • setExecutionTypeUntilFirstHit

      public void setExecutionTypeUntilFirstHit()
      Sets the execution type to "Until first hit".

    • isExecutionTypeUntilFirstHit

      public boolean isExecutionTypeUntilFirstHit()
      Returns:
      True if the execution type is set to "Until first hit"

    • isTimerControlInterval

      public boolean isTimerControlInterval()
      Returns:
      True if the Event is executed in a defined interval

    • setTimerControlInterval

      public void setTimerControlInterval(int interval)
      Sets the polling interval in minutes.
      Parameters:
      interval - Interval in minutes

    • getTimerControlMinutes

      public int getTimerControlMinutes()
      Returns the interval in minutes.
      Returns:
      Timer Interval in minutes

    • isTimerControlStartTime

      public boolean isTimerControlStartTime()
      Returns:
      True if the Event is set to be executed at a defined time

    • setTimerControlStartTime

      public void setTimerControlStartTime(Time start)
      Sets the start time of the event.
      Parameters:
      start - Start time

    • getTimerControlStartTime

      public Time getTimerControlStartTime()
      Gets the start time of the event.
      Returns:
      Start time

    • setTimerControlAuto

      public void setTimerControlAuto()
      Sets the TimeControl to Auto.

    • isTimerControlAuto

      public boolean isTimerControlAuto()
      Returns:
      true if Timer is Auto