Package com.uc4.communication.requests

Class CancelTask

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.CancelTask

public class CancelTask
extends XMLRequest

Cancels a task.

If a message is returned from the server the getMessageBox method returns the corresponding message.

Constructor Summary

Constructors

Constructor	Description
CancelTask(int[] runIds, boolean recursive)	Constructs a CancelTask using multiple RunIds.
CancelTask(int runID, boolean recursive)	Constructs a CancelTask using the specified RunID.

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 java.lang.String	getSrc()	Returns the request source.

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, isAllowedInClientZero, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelTask

public CancelTask(int runID,
                  boolean recursive)

Constructs a CancelTask using the specified RunID.

Parameters:

runID - RunID of the task

recursive - Also cancel sub tasks

CancelTask

public CancelTask(int[] runIds,
                  boolean recursive)

Constructs a CancelTask using multiple RunIds.

Parameters:

runIds - RunIds of the selected task

recursive - Also cancel sub tasks

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