Package com.uc4.communication.requests
Class AgentAssignmentList
- java.lang.Object
-
- com.uc4.communication.requests.XMLRequest
-
- com.uc4.communication.requests.AgentAssignmentList
-
public class AgentAssignmentList extends XMLRequest
List of Agent Assignments in the system overview. Use the request SaveAgentAssignment to change the list of active and inactive HSTA objects.
-
-
Constructor Summary
Constructors Constructor Description AgentAssignmentList()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Iterator<AgentAssignmentListItem>
activeAssignments()
Returns an iterator of active Agent assignments.int
activeSize()
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.java.util.Iterator<AgentAssignmentListItem>
inactiveAssignments()
Returns an iterator of inactive Agent assignments.int
inactiveSize()
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, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
-
-
-
-
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 classXMLRequest
- 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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- 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 classXMLRequest
- Parameters:
doc
- XML Documentsession
- Info about the user session
-
isAllowedInClientZero
protected boolean isAllowedInClientZero()
Description copied from class:XMLRequest
This method is used internally. Tests if thisXMLRequest
is allowed in client 0. The default implementation returnsfalse
, subclasses may override.- Overrides:
isAllowedInClientZero
in classXMLRequest
- Returns:
true
if this request is allowed in client 0,false
otherwise
-
activeAssignments
public java.util.Iterator<AgentAssignmentListItem> activeAssignments()
Returns an iterator of active Agent assignments. The returned elements can be used in the class SaveAgentAssignment to change the active assignments.- Returns:
- Iterator over active Agent assignments
-
inactiveAssignments
public java.util.Iterator<AgentAssignmentListItem> inactiveAssignments()
Returns an iterator of inactive Agent assignments. The returned elements can be used in the class SaveAgentAssignment to change the active assignments.- Returns:
- Iterator over inactive Agent assignments
-
activeSize
public int activeSize()
- Returns:
- Number of active assignments
-
inactiveSize
public int inactiveSize()
- Returns:
- Number of inactive assignments
-
-