Package com.uc4.communication.requests

Class DeepRename

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.DeepRename

public class DeepRename
extends XMLRequest

Rename an object including all objects in the same folder and below.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DeepRename.AbortIfNameExistsMode	AbortIfNameExistsMode.
static enum	DeepRename.IncludeFolderNamesMode	ChangeFolderNameMode.

Constructor Summary

Constructors

Constructor	Description
DeepRename()	Constructs a DeepRename request.

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 boolean	isAllowedInClientZero()	This method is used internally.
void	setAbortIfNameExists(DeepRename.AbortIfNameExistsMode nameExistsMode)	Sets the mode for abortIfNameExists.
void	setCleanPattern(String cleanPattern)	Sets the new name.
void	setIncludeFolderNames(DeepRename.IncludeFolderNamesMode includeFolderNamesMode)	Sets the mode for includeFolderNames.
void	setNamePattern(String namePattern)	Sets the name pattern of the object to rename.

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 Details

DeepRename

public DeepRename()

Constructs a DeepRename request.

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

setNamePattern

public void setNamePattern(String namePattern)

Sets the name pattern of the object to rename.

Parameters:

namePattern - wildcard with exactly one '*': like "BEGIN.*.END" new object names will be created like "BEGIN.NAME.END pattern must contain a '*', strings before/after the '*' are optional

setCleanPattern

public void setCleanPattern(String cleanPattern)

Sets the new name.

Parameters:

cleanPattern - wildcard with exactly one '*': like "BEFORE.*.AFTER" old object names are used to create new object names using parameter namePattern, however, cleanPatter is used to remove leading and/or trailing characters. in this example, prefix/postfix "BEFORE." / ".AFTER" is removed from the begin / end of old names and "BEGIN_" / "_END" is used as new prefix / postfix to create the new name, e.g., old name "BEFORE.NAME.AFTER" is converted to new name "BEGIN.NAME.END" pattern must contain a '*', strings before/after the '*' are optional

setAbortIfNameExists

public void setAbortIfNameExists(DeepRename.AbortIfNameExistsMode nameExistsMode)

Sets the mode for abortIfNameExists.

Parameters:

nameExistsMode - One of the AbortIfNameExistsMode defined in this class

setIncludeFolderNames

public void setIncludeFolderNames(DeepRename.IncludeFolderNamesMode includeFolderNamesMode)

Sets the mode for includeFolderNames.

Parameters:

includeFolderNamesMode - One of the IncludeFolderNamesMode defined in this class

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