Package com.uc4.communication.requests

Class TerminateAgentGroup

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.TerminateAgentGroup

public class TerminateAgentGroup
extends XMLRequest

Terminates all Agents in an AgentGroup.

Constructor Summary

Constructors

Constructor	Description
TerminateAgentGroup(AgentGroupListItem agentGroup)	Creates a new TerminateAgentGroup request to terminate all active Agents in the AgentGroup.
TerminateAgentGroup(List<AgentGroupListItem> agentGroupItems)	Constructs a TerminateAgentGroup using multiple AgentGroup list Items.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
protected 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 Details

TerminateAgentGroup

public TerminateAgentGroup(AgentGroupListItem agentGroup)

Creates a new TerminateAgentGroup request to terminate all active Agents in the AgentGroup.

Parameters:

agentGroup - AgentGroupListItem which was returned from the AgentGroupList request

TerminateAgentGroup

public TerminateAgentGroup(List<AgentGroupListItem> agentGroupItems)

Constructs a TerminateAgentGroup using multiple AgentGroup list Items.

Parameters:

agentGroupItems - AgentGroupListItem which was returned from the AgentGroupList requests

Method Details

getSrc

protected String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
 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

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