Package com.uc4.communication.requests
Class DuplicateObject
java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.DuplicateObject
Duplicates an UC4 Object.
-
Constructor Summary
ConstructorsConstructorDescriptionDuplicateObject
(UC4Object object, UC4ObjectName newName, IFolder folder) Creates a newDuplicateObject
request.DuplicateObject
(UC4ObjectName name, UC4ObjectName newName, IFolder folder) Creates a newDuplicateObject
request.DuplicateObject
(UC4ObjectName name, UC4ObjectName newName, IFolder folder, String title) Creates a newDuplicateObject
request. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
createRequest
(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.getID()
Returns the ID (OH_IDNR) of the created object.protected 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
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
-
Constructor Details
-
DuplicateObject
Creates a newDuplicateObject
request.- Parameters:
name
- Name of the UC4 Object which should be duplicatednewName
- Name of the created copyfolder
- Destination folder
-
DuplicateObject
Creates a newDuplicateObject
request. This request closes the givenUC4Object
, duplicates its representation in the database and opens the duplicated object. The givenUC4Object
will be replaced by the duplicated. Be aware that changes made on the givenUC4Object
but not saved will not be duplicated. Therefore you have to save the duplicated object as well.- Parameters:
object
- UC4 Object which should be duplicatednewName
- Name of the created copyfolder
- Destination folder- Throws:
IllegalArgumentException
- if object isnull
-
DuplicateObject
Creates a newDuplicateObject
request.- Parameters:
name
- UC4 Object which should be duplicatednewName
- Name of the created copyfolder
- Destination foldertitle
- Title for new object
-
-
Method Details
-
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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the session
-
getSrc
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- Returns:
- Source
-
handleContent
Description copied from class:XMLRequest
Sub classes extract the values from the XML document and provide public getter methods.- Overrides:
handleContent
in classXMLRequest
- Parameters:
doc
- XML Documentsession
- Info about the user session
-
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 thisXMLRequest
is allowed in client 0. The default implementation returnsfalse
, subclasses may override.- Overrides:
isAllowedInClientZero
in classXMLRequest
- Returns:
true
if this request is allowed in client 0,false
otherwise
-