com.uc4.communication.requests

Class ModifyQueueStatus

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ModifyQueueStatus

public class ModifyQueueStatus
extends XMLRequest

Sets the status of a Queue to Stop or Go.

Constructor Summary

Constructors

Constructor and Description
ModifyQueueStatus(QueueListItem item, QueueStatus status) Creates a new instance of a SwitchQueueStatus class.
ModifyQueueStatus(UC4ObjectName name, QueueStatus status) Creates a new instance of a SwitchQueueStatus class.

Method Summary

Modifier and Type	Method and Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.
protected java.lang.String	getSrc() Returns the request source.
protected boolean	isAllowedInClientZero() This method is used internally.

Methods inherited from class com.uc4.communication.requests.XMLRequest

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleContent, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifyQueueStatus

public ModifyQueueStatus(UC4ObjectName name,
                         QueueStatus status)

Creates a new instance of a SwitchQueueStatus class.

Parameters:

name - Name of the Queue Object

status - Status: QueueStatus.RED to stop the Queue or QueueStatus.GREEN to enable it again.

ModifyQueueStatus

public ModifyQueueStatus(QueueListItem item,
                         QueueStatus status)

Creates a new instance of a SwitchQueueStatus class.

Parameters:

item - Item from the QueueList

status - Status: QueueStatus.RED to stop the Queue or QueueStatus.GREEN to enable it again.

Method Detail

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.Element request,
                             ConnectionAttributes sessionInfo)

Description copied from class: XMLRequest

Creates the XML Document for the request. This method is used internally.

Specified by:

createRequest in class XMLRequest

Parameters:

doc - Document, used to create new Elements

request - Request Element - classes append information to this request element

sessionInfo - Information about the session

getSrc

protected java.lang.String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

isAllowedInClientZero

protected boolean isAllowedInClientZero()

Description copied from class: XMLRequest

This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.

Overrides:

isAllowedInClientZero in class XMLRequest

Returns:

true if this request is allowed in client 0, false otherwise