Package com.uc4.communication.requests

Class ReportTypeList

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ReportTypeList

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>

public class ReportTypeList
extends XMLRequest
implements java.lang.Iterable<java.lang.String>

Gets a list of report types for a specified RunID.

Constructor Summary

Constructors

Constructor	Description
ReportTypeList(int runID)	Constructs a ReportTypes using the specified RunID.

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.String	getCaption(java.lang.String reportType)	Returns the caption for the report type.
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.String>	iterator()	Returns an array of report types which are available for this RunID.
int	size()	Returns the number of report types.

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

ReportTypeList

public ReportTypeList(int runID)

Constructs a ReportTypes using the specified RunID.

Parameters:

runID - RunID

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

iterator

public java.util.Iterator<java.lang.String> iterator()

Returns an array of report types which are available for this RunID.

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

Returns:

list of report types

getCaption

public java.lang.String getCaption(java.lang.String reportType)

Returns the caption for the report type.

Parameters:

reportType - Report ID as returned by the iterator() method.

Returns:

Translated Text

size

public int size()

Returns the number of report types.

Returns:

Number of report types

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