Package com.uc4.api.objects

Class QueueExceptionCondition

java.lang.Object

com.uc4.api.objects.QueueExceptionCondition

public class QueueExceptionCondition
extends java.lang.Object

This class represents a single line in the Exception table of a Queue object.

Constructor Summary

Constructors

Modifier	Constructor	Description
	QueueExceptionCondition(CalendarCondition cale, Time from, Time to, int maxSlots, int priority, java.lang.String description)	Creates a new QueueExceptionCondition.
protected	QueueExceptionCondition(com.uc4.util.XMLDocument doc, org.w3c.dom.Element row)

Method Summary

Modifier and Type	Method	Description
CalendarCondition	getCalendarCondition()	Returns the CalendarCondition.
java.lang.String	getDescription()
Time	getFrom()	Returns the start of the validity period.
int	getMaxSlots()
int	getPriority()	Priority with which this Queue should be executed in the Automation Engine.
Time	getTo()	Returns the end of the validity period.
void	setCalendarCondition(CalendarCondition cale)	Sets the calendar condition.
void	setDescription(java.lang.String description)	Sets the description of this Queue Exception.
void	setFrom(Time from)	Sets the start time.
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 the Automation Engine.
void	setTo(Time to)	Sets the end time.
protected void	store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element exceptionElement)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueueExceptionCondition

public QueueExceptionCondition(CalendarCondition cale,
                               Time from,
                               Time to,
                               int maxSlots,
                               int priority,
                               java.lang.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,
                                  org.w3c.dom.Element row)

Method Detail

store

protected void store(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.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 java.lang.String getDescription()

Returns:

Description

setDescription

public void setDescription(java.lang.String description)

Sets the description of this Queue Exception.

Parameters:

description - String with max. 255 characters

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object