com.uc4.communication.requests

Class ReplaceObject

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ReplaceObject

public class ReplaceObject
extends XMLRequest

Replaces UC4 objects.

Constructor Summary

Constructors

Constructor and Description
ReplaceObject(GetReplaceList list) This request is used to replace the use of all selected objects provided by the GetReplaceList request.
ReplaceObject(GetReplaceList list, java.util.List<java.lang.String> itemsToReplace) This request is used to replace the use of selected objects
ReplaceObject(GetReplaceList list, UC4ObjectName name, int replaceMax) Replaces an UC4 Object.
ReplaceObject(UC4ObjectName oldName, java.lang.String type, UC4ObjectName newName, SearchResultItem... results) Replaces an UC4 Object based on a search result.

Method Summary

Modifier and Type	Method and Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.
protected java.lang.String	getSrc() Returns the request source.
protected boolean	isAllowedInClientZero() This method is used internally.

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, handleContent, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplaceObject

public ReplaceObject(GetReplaceList list)

This request is used to replace the use of all selected objects provided by the GetReplaceList request.

Parameters:

list - Replace list

ReplaceObject

public ReplaceObject(GetReplaceList list,
                     java.util.List<java.lang.String> itemsToReplace)

This request is used to replace the use of selected objects

Parameters:

list - Replace list

itemsToReplace - ID of items

ReplaceObject

public ReplaceObject(GetReplaceList list,
                     UC4ObjectName name,
                     int replaceMax)

Replaces an UC4 Object.

Parameters:

list - List of occurrence

name - Name of the replacement

replaceMax - Maximum number of replaces at once

ReplaceObject

public ReplaceObject(UC4ObjectName oldName,
                     java.lang.String type,
                     UC4ObjectName newName,
                     SearchResultItem... results)

Replaces an UC4 Object based on a search result.

Parameters:

oldName - Name of the object which should be replaced

type - Object type, for example JOBS

newName - Object name of the replacement

results - Items to replace based on a search result (search for use)

Method Detail

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.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

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

getSrc

protected java.lang.String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source