Package com.uc4.communication.requests

Class TaskStatistics

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.TaskStatistics

All Implemented Interfaces:

java.lang.Iterable<StatisticSearchItem>

public class TaskStatistics
extends XMLRequest
implements java.lang.Iterable<StatisticSearchItem>

Reads the statistics of a single task.

Constructor Summary

Constructors

Constructor	Description
TaskStatistics(int runID)	Creates a request instance to read the statistic of the specified task.
TaskStatistics(int runID, int lnr)	Creates a request instance to read the statistic of the specified task inside another task.

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<StatisticSearchItem>	iterator()
void	setMaxResult(int maxResult)	Sets the maximum number of returned rows.
int	size()	Returns the number of items in the result.

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TaskStatistics

public TaskStatistics(int runID)

Creates a request instance to read the statistic of the specified task.

Parameters:

runID - runnumber of the task in the parent task

TaskStatistics

public TaskStatistics(int runID,
                      int lnr)

Creates a request instance to read the statistic of the specified task inside another task.

Parameters:

runID - run id of the parent task

lnr - runnumber of the task in the parent task

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

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

setMaxResult

public void setMaxResult(int maxResult)

Sets the maximum number of returned rows.

Parameters:

maxResult - Integer between 1 and 5000

size

public int size()

Returns the number of items in the result.

Returns:

Number of StatisticSearchItem items

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

iterator

public java.util.Iterator<StatisticSearchItem> iterator()

Specified by:

iterator in interface java.lang.Iterable<StatisticSearchItem>