Package 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	Description
ObjectStatistics(UserListItem user)	Creates a request to read the statistics of a user object.
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(String userID)	Creates a request to read the statistics of a user object.

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.
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<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

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

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(String userID)

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

Parameters:

userID - id of the user from UserListRowItem

See Also:

• com.uc4.ecc.backends.dataservice.userlist.IUserListRowItem#getId()

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 Details

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

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

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

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

iterator

public Iterator<StatisticSearchItem> iterator()

Specified by:

iterator in interface Iterable<StatisticSearchItem>