Package com.uc4.communication.requests

Class GetLastRuntimes

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetLastRuntimes

public class GetLastRuntimes
extends XMLRequest

Returns real runtimes (RRT) and estimated runtimes (ERT) of the last 25 runs of an activatable object.

Constructor Summary

Constructors

Constructor	Description
GetLastRuntimes(int ohIdnr)	Creates a new request to get the last 25 RRTs and ERTs.
GetLastRuntimes(UC4ObjectName name)	Creates a new request to get the last 25 RRTs and ERTs.

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.
java.lang.Long	getEstimatedRuntime(int runNumber)	This method returns one of 25 estimated runtimes measured in seconds.
java.lang.Long	getRealRuntime(int runNumber)	This method returns one of 25 real runtimes measured in seconds.
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<java.lang.Long>	lastEstimatedRuntimes()	This method provides the last 25 estimated runtimes measured in seconds.
java.util.Iterator<java.lang.Long>	lastRealRuntimes()	This method provides the last 25 real runtimes measured in seconds.

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

GetLastRuntimes

public GetLastRuntimes(UC4ObjectName name)

Creates a new request to get the last 25 RRTs and ERTs.

Parameters:

name - Name of the UC4 Object

GetLastRuntimes

public GetLastRuntimes(int ohIdnr)

Creates a new request to get the last 25 RRTs and ERTs.

Parameters:

ohIdnr - OH_Idnr

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

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

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

lastRealRuntimes

public java.util.Iterator<java.lang.Long> lastRealRuntimes()

This method provides the last 25 real runtimes measured in seconds. The elements are ordered ascending. That means the first element represents the youngest last run and the last element in this iterator represents the oldest last run. If there are not 25 last runs 0 is assumed as real time for that runs.

Returns:

Iterator of the last 25 runs ordered ascending

getRealRuntime

public java.lang.Long getRealRuntime(int runNumber)

This method returns one of 25 real runtimes measured in seconds. The parameter runNumber choose which one: 0 = youngest last run, 24 = oldest last run. If there are not 25 last runs 0 is assumed as real time for that runs.

Parameters:

runNumber - 0 = youngest last run, 24 = oldest last run

Returns:

realRuntime of runNumber

lastEstimatedRuntimes

public java.util.Iterator<java.lang.Long> lastEstimatedRuntimes()

This method provides the last 25 estimated runtimes measured in seconds. The elements are ordered ascending. That means the first element represents the youngest last run and the last element in this iterator represents the oldest last run. If there are not 25 last runs 1 is assumed as estimated time for that runs.

Returns:

Iterator of the last 25 runs ordered ascending

getEstimatedRuntime

public java.lang.Long getEstimatedRuntime(int runNumber)

This method returns one of 25 estimated runtimes measured in seconds. The parameter runNumber choose which one: 0 = youngest last run, 24 = oldest last run. If there are not 25 last runs 1 is assumed as estimated time for that runs.

Parameters:

runNumber - 0 = youngest last run, 24 = oldest last run

Returns:

estimatedRuntime of runNumber