Package com.uc4.communication.requests
Class DeleteObject
java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.DeleteObject
Deletes an UC4 object.
-
Constructor Summary
ConstructorsConstructorDescriptionDeleteObject
(IFolder folder) This constructor is used to delete FOLD objects in UC4.DeleteObject
(IFolder[] folders) This constructor is used to delete multiple FOLD objects in AE.DeleteObject
(UserListItem user) Constructs aDeleteObject
to remove a user based on the user list in the system overview.DeleteObject
(UserListItem[] users) Constructs aDeleteObject
to remove multiple users.DeleteObject
(UC4ObjectName objectName) Deletes the specified object.DeleteObject
(UC4ObjectName[] names) Deletes UC4 Objects with the specified names.DeleteObject
(UC4ObjectName[] names, IFolder[] folders) This constructor is used to delete multiple FOLD and UC4Object objects in AE.DeleteObject
(UC4ObjectName objectName, IFolder folder) Constructs aDeleteObject
using the specified UC4 object name.DeleteObject
(String[] userIds) Delete all the objects with the matching ids. -
Method Summary
Modifier and TypeMethodDescriptionprotected 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
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
-
Constructor Details
-
DeleteObject
Constructs aDeleteObject
using the specified UC4 object name.- Parameters:
objectName
- Name of the UC4 Objectfolder
- Folder
-
DeleteObject
Constructs aDeleteObject
to remove a user based on the user list in the system overview.- Parameters:
user
- User in the system overview
-
DeleteObject
Constructs aDeleteObject
to remove multiple users.- Parameters:
users
- Users which should be deleted
-
DeleteObject
Delete all the objects with the matching ids.- Parameters:
userIds
- Ids of the objects to be removed.
-
DeleteObject
Deletes UC4 Objects with the specified names.- Parameters:
names
- Array of names
-
DeleteObject
Deletes the specified object.- Parameters:
objectName
- Name of the UC4 Object
-
DeleteObject
This constructor is used to delete FOLD objects in UC4. Folder cannot be deleted using the constructorDeleteObject(UC4ObjectName objectName, IFolder folder)
because a folder name is not unique in an UC4 client. For example a folder can contain a folder with the same name as sub folder.- Parameters:
folder
- Folder which should be deleted
-
DeleteObject
This constructor is used to delete multiple FOLD objects in AE.- Parameters:
folders
- Array of Folder which should be deleted.
-
DeleteObject
This constructor is used to delete multiple FOLD and UC4Object objects in AE.- Parameters:
names
- Array of Names which should to be deletedfolders
- Array of Folder which should be deleted
-
-
Method Details
-
getSrc
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- 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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the session
-
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
-