com.uc4.communication.requests

Class GetSyncUsage

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetSyncUsage

All Implemented Interfaces:

java.lang.Iterable<UC4ObjectName>

public class GetSyncUsage
extends XMLRequest
implements java.lang.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 and 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

Methods

Modifier and Type	Method and Description
java.util.Iterator<UC4ObjectName>	iterator()
int	size() Returns the number of SYNC objects.

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

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 Detail

iterator

public java.util.Iterator<UC4ObjectName> iterator()

Specified by:

iterator in interface java.lang.Iterable<UC4ObjectName>

size

public int size()

Returns the number of SYNC objects.

Returns:

Result count