com.uc4.communication.requests

Class DeleteObject

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.DeleteObject

public class DeleteObject
extends XMLRequest

Deletes an UC4 object.

Constructor Summary

Constructors

Constructor and Description
DeleteObject(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(java.lang.String[] userIds) Delete all the objects with the matching ids.
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 a DeleteObject using the specified UC4 object name.
DeleteObject(UserListItem user) Constructs a DeleteObject to remove a user based on the user list in the system overview.
DeleteObject(UserListItem[] users) Constructs a DeleteObject to remove multiple users.

Method Summary

Modifier and Type	Method and Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.
protected java.lang.String	getSrc() Returns the request source.
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, 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 Detail

DeleteObject

public DeleteObject(UC4ObjectName objectName,
                    IFolder folder)

Constructs a DeleteObject using the specified UC4 object name.

Parameters:

objectName - Name of the UC4 Object

folder - Folder

DeleteObject

public DeleteObject(UserListItem user)

Constructs a DeleteObject to remove a user based on the user list in the system overview.

Parameters:

user - User in the system overview

DeleteObject

public DeleteObject(UserListItem[] users)

Constructs a DeleteObject to remove multiple users.

Parameters:

users - Users which should be deleted

DeleteObject

public DeleteObject(java.lang.String[] userIds)

Delete all the objects with the matching ids.

Parameters:

userIds - Ids of the objects to be removed.

DeleteObject

public DeleteObject(UC4ObjectName[] names)

Deletes UC4 Objects with the specified names.

Parameters:

names - Array of names

DeleteObject

public DeleteObject(UC4ObjectName objectName)

Deletes the specified object.

Parameters:

objectName - Name of the UC4 Object

DeleteObject

public DeleteObject(IFolder folder)

This constructor is used to delete FOLD objects in UC4. Folder cannot be deleted using the constructor DeleteObject(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

public DeleteObject(IFolder[] folders)

This constructor is used to delete multiple FOLD objects in AE.

Parameters:

folders - Array of Folder which should be deleted.

DeleteObject

public DeleteObject(UC4ObjectName[] names,
                    IFolder[] folders)

This constructor is used to delete multiple FOLD and UC4Object objects in AE.

Parameters:

names - Array of Names which should to be deleted

folders - Array of Folder which should be deleted

Method Detail

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

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