Package com.uc4.api.objects

Class QueueExceptionCondition

java.lang.Object
com.uc4.api.objects.QueueExceptionCondition
public class QueueExceptionCondition extends Object
This class represents a single line in the Exception table of a Queue object.

  • Constructor Details

    • QueueExceptionCondition

      public QueueExceptionCondition(CalendarCondition cale, Time from, Time to, int maxSlots, int priority, String description)
      Creates a new QueueExceptionCondition.
      Parameters:
      cale - Calendar condition
      from - From time
      to - To time
      maxSlots - Maximum number of slots
      priority - Priority
      description - Description

    • QueueExceptionCondition

      protected QueueExceptionCondition(com.uc4.util.XMLDocument doc, Element row)

  • Method Details

    • store

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

    • getCalendarCondition

      public CalendarCondition getCalendarCondition()
      Returns the CalendarCondition.
      Returns:
      CalendarCondition

    • setCalendarCondition

      public void setCalendarCondition(CalendarCondition cale)
      Sets the calendar condition.
      Parameters:
      cale - CalendarCondition

    • getFrom

      public Time getFrom()
      Returns the start of the validity period.
      Returns:
      Time instance

    • setFrom

      public void setFrom(Time from)
      Sets the start time.
      Parameters:
      from - Time instance

    • getTo

      public Time getTo()
      Returns the end of the validity period.
      Returns:
      Time instance

    • setTo

      public void setTo(Time to)
      Sets the end time.
      Parameters:
      to - Time instance

    • getMaxSlots

      public int getMaxSlots()
      Returns:
      The maximum number of slots or -1 if unlimited.

    • setMaxSlots

      public void setMaxSlots(int maxSlots)
      Sets the maximum number of slots for this Queue. The value -1 can be used to set max slots to unlimited.
      Parameters:
      maxSlots - Positive Integer between 0 and 100000 or -1 for unlimited

    • getPriority

      public int getPriority()
      Priority with which this Queue should be executed in the Automation Engine. Permitted values: 0 to 255
      Default: 0
      1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.
      Returns:
      priority

    • setPriority

      public void setPriority(int priority)
      Priority with which this Queue should be executed in the Automation Engine. Permitted values: 0 to 255
      Default: 0
      1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.
      Parameters:
      priority - Priority

    • getDescription

      public String getDescription()
      Returns:
      Description

    • setDescription

      public void setDescription(String description)
      Sets the description of this Queue Exception.
      Parameters:
      description - String with max. 255 characters

    • toString

      public String toString()
      Overrides:
      toString in class Object