com.uc4.communication.requests

Class GetComments

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetComments

All Implemented Interfaces:

java.lang.Iterable<GetComments.Comment>

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

Returns the comments of a task.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getComments() Returns the comments as String.
java.util.Iterator<GetComments.Comment>	iterator()
int	size() Returns the number of comments.

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetComments

public GetComments(int runID)

Returns all comments for the specified task.

Parameters:

runID - runID of the task

Method Detail

getComments

public java.lang.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 java.util.Iterator<GetComments.Comment> iterator()

Specified by:

iterator in interface java.lang.Iterable<GetComments.Comment>

size

public int size()

Returns the number of comments.

Returns:

Number of comments