Package com.uc4.api.objects
Class QueueAttributes
java.lang.Object
com.uc4.api.objects.QueueAttributes
This class represents the "Queue" tab of a Queue object.
Methods in this class can be used to read and modify the Queue object.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a newQueueExceptionCondition
to the list of exceptions.void
Clears the list ofExceptionConditons
.The returnedjava.util.Iterator
can be used to read the list of exception conditions of this Queue.int
int
int
Priority with which this Queue should be executed in UC4.boolean
void
setConsiderERT
(boolean considerERT) Sets a flag to define if the Estimated Runtime should be considered for the calculation.void
setMaxSlots
(int maxSlots) Sets the maximum number of slots for this Queue.void
setPriority
(int priority) Priority with which this Queue should be executed in UC4.void
setTimezone
(UC4TimezoneName timezone) Sets the timezone of the Queue object.protected void
-
Constructor Details
-
QueueAttributes
protected QueueAttributes(com.uc4.util.XMLDocument doc)
-
-
Method Details
-
store
-
getExceptionCount
public int getExceptionCount()- Returns:
- Number of
QueueExceptionCondition
for this Queue.
-
exceptionIterator
The returnedjava.util.Iterator
can be used to read the list of exception conditions of this Queue. Theremove
method of the Iterator can be used to remove date/time conditions.- Returns:
- Iterator over
QueueExceptionCondition
-
clearExceptionConditons
public void clearExceptionConditons()Clears the list ofExceptionConditons
. -
addExceptionCondition
Adds a newQueueExceptionCondition
to the list of exceptions. The new element is added at the end of the list.- Parameters:
cond
- Instance of a QueueExceptionCondition class
-
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 UC4. 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 UC4. 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
-
isConsiderERT
public boolean isConsiderERT()- Returns:
- true if the Estimated Runtime should be considered for the calculation.
-
setConsiderERT
public void setConsiderERT(boolean considerERT) Sets a flag to define if the Estimated Runtime should be considered for the calculation.- Parameters:
considerERT
- true if the Estimated Runtime should be considered for the calculation, false otherwise
-
getTimezone
- Returns:
- Timezone
-
setTimezone
Sets the timezone of the Queue object.- Parameters:
timezone
- Timezone
-