Package com.uc4.communication.requests

Class GetComments

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetComments

All Implemented Interfaces:

Iterable<GetComments.Comment>

public class GetComments
extends XMLRequest
implements Iterable<GetComments.Comment>

Returns the comments of a task.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetComments.Comment	This class represents a single comment from one user.

Constructor Summary

Constructors

Constructor	Description
GetComments(int runID)	Returns all comments for the specified task.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
String	getComments()	Returns the comments as String.
protected 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.
Iterator<GetComments.Comment>	iterator()
int	size()	Returns the number of comments.

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 Details

GetComments

public GetComments(int runID)

Returns all comments for the specified task.

Parameters:

runID - runID of the task

Method Details

getSrc

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

getComments

public String getComments()

Returns the comments as String. The returned String contains multiple lines. If the runID is valid but no comment has been set for this task the return value is an empty String.

Returns:

comments or null in case of an error.

iterator

public Iterator<GetComments.Comment> iterator()

Specified by:

iterator in interface Iterable<GetComments.Comment>

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

size

public int size()

Returns the number of comments.

Returns:

Number of comments