CancelForm (java-api 24.2.0 API)

java.lang.Object
- com.uc4.communication.requests.XMLRequest
- - com.uc4.communication.requests.CancelForm

```
public class CancelForm
extends XMLRequest
```
Cancels a pending Read Request.
This is the same action as the canel button of a read form in the UC4 GUI.

Constructor Summary

Constructors
Constructor Description

CancelForm(Form read)
Creates a CancelForm Object.

CancelForm(java.util.List<Form> readForms)
Creates a CancelForm Object.

Method Summary

All Methods Instance Methods Concrete Methods
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
  - CancelForm
```
public CancelForm(Form read)
```
    Creates a CancelForm Object.
    
    Parameters:
    
    read - Read Mask (Read object) which should be canceled
  - CancelForm
```
public CancelForm(java.util.List<Form> readForms)
```
    Creates a CancelForm Object.
    
    Parameters:
    
    readForms - Read Masks (Read objects) which should be canceled
- 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