com.uc4.communication.requests

Class ObjectStatistics

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ObjectStatistics

All Implemented Interfaces:

Iterable<StatisticSearchItem>

public class ObjectStatistics
extends XMLRequest
implements Iterable<StatisticSearchItem>

Reads the statistics of a single UC4 object.

Constructor Summary

Constructors

Constructor and Description
ObjectStatistics(UC4ObjectName name) Creates a request instance to read the statistic of the specified object.
ObjectStatistics(UC4ObjectName name, int maxResult) Creates a request instance to read the statistic of the specified object.
ObjectStatistics(UserListItem user) Creates a request to read the statistics of a user object.

Method Summary

Modifier and Type	Method and Description
Iterator<StatisticSearchItem>	iterator()
Iterator<StatisticSearchItem>	resultIterator() Deprecated. Use the iterator() method instead, the iterator() method never returns null.
int	size() Returns the number of items in the result.

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

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ObjectStatistics

public ObjectStatistics(UC4ObjectName name)

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

Parameters:

name - Name of the UC4 object

ObjectStatistics

public ObjectStatistics(UserListItem user)

Creates a request to read the statistics of a user object.

Parameters:

user - Entry of the user list in the system overview

ObjectStatistics

public ObjectStatistics(UC4ObjectName name,
                        int maxResult)

Creates a request instance to read the statistic of the specified object. The maximum number of returned rows can be set in the second parameter.

Parameters:

name - Name of the UC4 object

maxResult - Maximum number of rows, Integer between 1 and 5000

Method Detail

resultIterator

@Deprecated
public Iterator<StatisticSearchItem> resultIterator()

Deprecated. Use the iterator() method instead, the iterator() method never returns null.

Returns an iterator over StatisticSearchItem.

Returns:

iterator over StatisticSearchItem or null if this request does not contain a search result

size

public int size()

Returns the number of items in the result.

Returns:

Number of StatisticSearchItem items

iterator

public Iterator<StatisticSearchItem> iterator()

Specified by:

iterator in interface Iterable<StatisticSearchItem>