Package com.uc4.communication.requests

Class GetSyncUsage

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetSyncUsage

All Implemented Interfaces:

Iterable<UC4ObjectName>

public class GetSyncUsage
extends XMLRequest
implements Iterable<UC4ObjectName>

Returns a list of SYNC Object names that are currently used. This request requires a running JWP.

Since:

V12

Constructor Summary

Constructors

Constructor	Description
GetSyncUsage()	Creates a new GetSyncUsage request for all current used objects.
GetSyncUsage(int runID)	Creates a new GetSyncUsage request that returns SYNC objects used by a specified RunID.

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<UC4ObjectName>	iterator()
int	size()	Returns the number of SYNC objects.

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

GetSyncUsage

public GetSyncUsage()

Creates a new GetSyncUsage request for all current used objects.

GetSyncUsage

public GetSyncUsage(int runID)

Creates a new GetSyncUsage request that returns SYNC objects used by a specified RunID.

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

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<UC4ObjectName> iterator()

Specified by:

iterator in interface Iterable<UC4ObjectName>

size

public int size()

Returns the number of SYNC objects.

Returns:

Result count