Package com.uc4.communication.requests

Class AgentGroupSimulation

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.AgentGroupSimulation

public class AgentGroupSimulation
extends XMLRequest

Simulation view of an AgentGroup.

Constructor Summary

Constructors

Constructor	Description
AgentGroupSimulation(UC4ObjectName agentGroup)	Creates a new AgentGroupSimulation request.

Method Summary

Modifier and Type	Method	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 void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
protected boolean	isAllowedInClientZero()	This method is used internally.
java.util.Iterator<AgentListItem>	selectedAgents()
int	selectedAgentSize()
java.util.Iterator<AgentListItem>	unselectedAgents()
int	unselectedAgentSize()

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, 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

AgentGroupSimulation

public AgentGroupSimulation(UC4ObjectName agentGroup)

Creates a new AgentGroupSimulation request.

Parameters:

agentGroup - Name of the AgentGroup

Method Detail

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

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

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
                             ConnectionAttributes session)

Description copied from class: XMLRequest

Sub classes extract the values from the XML document and provide public getter methods.

Overrides:

handleContent in class XMLRequest

Parameters:

doc - XML Document

session - Info about the user 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

selectedAgents

public java.util.Iterator<AgentListItem> selectedAgents()

Returns:

Agents which are selected in this simulation for the specified AgentGroup.

unselectedAgents

public java.util.Iterator<AgentListItem> unselectedAgents()

Returns:

Agents which are not selected in this simulation.

selectedAgentSize

public int selectedAgentSize()

Returns:

Number of selected Agents.

unselectedAgentSize

public int unselectedAgentSize()

Returns:

Number of skipped Agents.