Package com.uc4.communication.requests

Class DuplicateObject

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.DuplicateObject

public class DuplicateObject
extends XMLRequest

Duplicates an UC4 Object.

Constructor Summary

Constructors

Constructor	Description
DuplicateObject(UC4Object object, UC4ObjectName newName, IFolder folder)	Creates a new DuplicateObject request.
DuplicateObject(UC4ObjectName name, UC4ObjectName newName, IFolder folder)	Creates a new DuplicateObject request.
DuplicateObject(UC4ObjectName name, UC4ObjectName newName, IFolder folder, java.lang.String title)	Creates a new DuplicateObject request.

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.
java.lang.String	getID()	Returns the ID (OH_IDNR) of the created object.
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	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, 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

DuplicateObject

public DuplicateObject(UC4ObjectName name,
                       UC4ObjectName newName,
                       IFolder folder)

Creates a new DuplicateObject request.

Parameters:

name - Name of the UC4 Object which should be duplicated

newName - Name of the created copy

folder - Destination folder

DuplicateObject

public DuplicateObject(UC4Object object,
                       UC4ObjectName newName,
                       IFolder folder)

Creates a new DuplicateObject request. This request closes the given UC4Object, duplicates its representation in the database and opens the duplicated object. The given UC4Object will be replaced by the duplicated. Be aware that changes made on the given UC4Object but not saved will not be duplicated. Therefore you have to save the duplicated object as well.

Parameters:

object - UC4 Object which should be duplicated

newName - Name of the created copy

folder - Destination folder

Throws:

java.lang.IllegalArgumentException - if object is null

DuplicateObject

public DuplicateObject(UC4ObjectName name,
                       UC4ObjectName newName,
                       IFolder folder,
                       java.lang.String title)

Creates a new DuplicateObject request.

Parameters:

name - UC4 Object which should be duplicated

newName - Name of the created copy

folder - Destination folder

title - Title for new object

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

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

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

getID

public java.lang.String getID()

Returns the ID (OH_IDNR) of the created object.

Returns:

ID of the Object or null if this request has not been sent or if the duplication failed

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