com.uc4.communication.requests

Class GetReplaceList

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetReplaceList

public class GetReplaceList
extends XMLRequest

Returns list of UC4 Objects in which the specified UC4 Object is used.

Constructor Summary

Constructors

Constructor and Description
GetReplaceList(RenameObject rename) Creates a new GetReplaceList request using the specified RenameObject instance.
GetReplaceList(UC4ObjectName obj) Creates a new GetReplaceList request to replace the specified object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCountDescription()
boolean	hasMore() There is more to replace.
int	size()

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

GetReplaceList

public GetReplaceList(RenameObject rename)

Creates a new GetReplaceList request using the specified RenameObject instance. The RenameObject instance must already be executed and its return value must be message box with the number 4005704. This message number means that the object which should renamed is used in other objects. The newly created instance of GetReplaceList can be used to get the list of these objects.

Parameters:

rename - Already executed RenameObject request

GetReplaceList

public GetReplaceList(UC4ObjectName obj)

Creates a new GetReplaceList request to replace the specified object. The returned list does not actually replace the object. this is done using the request ReplaceObject

Parameters:

obj - Name of the object to replace

Method Detail

size

public int size()

Returns:

Number of items

getCountDescription

public java.lang.String getCountDescription()

Returns:

Description of the item count.

hasMore

public boolean hasMore()

There is more to replace.

Returns:

True if more objects can be replaced