Package com.uc4.communication.requests

Class RenameObject

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.RenameObject

public class RenameObject
extends XMLRequest

Renames an existing UC4 Object.

Constructor Summary

Constructors

Constructor	Description
RenameObject(IFolder oldName, UC4ObjectName newName)	This constructor is used to rename folders.
RenameObject(IFolder oldName, UC4ObjectName newName, java.lang.String title)	This constructor is used to rename folders.
RenameObject(UC4ObjectName oldName, UC4ObjectName newName, IFolder folder)	Deprecated. Use RenameObject(UC4ObjectName oldName, UC4ObjectName newName, IFolder folder, String title) instead
RenameObject(UC4ObjectName oldName, UC4ObjectName newName, IFolder folder, java.lang.String title)	Constructs a RenameObject.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
protected org.w3c.dom.Element	getReplaceRequest()
protected java.lang.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	ignoreMessageBox()
protected boolean	isAllowedInClientZero()	This method is used internally.
void	setForceRename()	Method to rename the object forcefully.
void	setRenameIfUsed(boolean renameIfUsed)	The parameter renameIfUsed can be set to false to prevent objects from beeing renamend if they are used in other 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, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Constructor Detail

RenameObject

@Deprecated
public RenameObject(UC4ObjectName oldName,
                    UC4ObjectName newName,
                    IFolder folder)

Deprecated.

Use RenameObject(UC4ObjectName oldName, UC4ObjectName newName, IFolder folder, String title) instead

Constructs a RenameObject. This constructor is used to rename UC4 Objects except folders. To rename a folder use the constructor RenameObject(IFolder oldName, UC4ObjectName newName).

Parameters:

oldName - Name of the UC4 Object which should be renamed.

newName - New name

folder - Folder containing the object

RenameObject

public RenameObject(UC4ObjectName oldName,
                    UC4ObjectName newName,
                    IFolder folder,
                    java.lang.String title)

Constructs a RenameObject. This constructor is used to rename UC4 Objects except folders. To rename a folder use the contructor RenameObject(IFolder oldName, UC4ObjectName newName).

Parameters:

oldName - Name of the UC4 Object which should be renamed.

newName - New name

folder - Folder containing the object

title - New title of the object

RenameObject

public RenameObject(IFolder oldName,
                    UC4ObjectName newName)

This constructor is used to rename folders.

Parameters:

oldName - Folder which should be renamed

newName - New name of the folder

RenameObject

public RenameObject(IFolder oldName,
                    UC4ObjectName newName,
                    java.lang.String title)

This constructor is used to rename folders.

Parameters:

oldName - Folder which should be renamed

newName - New name of the folder

title - New title of the folder

Method Detail

setRenameIfUsed

public void setRenameIfUsed(boolean renameIfUsed)

The parameter renameIfUsed can be set to false to prevent objects from beeing renamend if they are used in other objects. The default behavior is to rename without searching for the use.

Parameters:

renameIfUsed - If set to false a message box is returned if the object is used.

setForceRename

public void setForceRename()

Method to rename the object forcefully.

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

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

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

getReplaceRequest

protected org.w3c.dom.Element getReplaceRequest()

ignoreMessageBox

protected boolean ignoreMessageBox()

Overrides:

ignoreMessageBox in class XMLRequest

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