FormRecordData (formcycle: bom 8.5.6 API)

java.lang.Object
- de.xima.fc.e2e.common.query.data.FormRecordData

All Implemented Interfaces:

Serializable
```
public final class FormRecordData
extends Object
implements Serializable
```
Basic info of a formcycle form record, used by queries made by E2E test against a formcycle app running inside a servlet container.
Note that since the tests are running outside a formcycle context, formcycle specific classes are not available, so all parameters and return values must not reference formcycle specific classes. Thus we need to create separate classes for the data we wish to transfer between the E2E tests and the formcycle app.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class FormRecordData.Builder
Simple builder for a FormRecordData.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static FormRecordData.Builder`	`builder()`
`EntityReference`	`getCurrentState()`
`String`	`getCurrentStateName()`
`long`	`getErrorCount()`
`EntityReference`	`getForm()`
`long`	`getId()`
`String`	`getProcessId()`
`String`	`getSubject()`
`boolean`	`isInProgress()`
`boolean`	`isRead()`
`boolean`	`isSaved()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getCurrentState
```
public EntityReference getCurrentState()
```
    Returns:
    
    The current workflow state of the form record, if any.
  - getCurrentStateName
```
public String getCurrentStateName()
```
    Returns:
    
    The name of the current workflow state, if any.
  - getErrorCount
```
public long getErrorCount()
```
    Returns:
    
    The number of errors of the form record.
  - getForm
```
public EntityReference getForm()
```
    Returns:
    
    The form to which the form record belongs.
  - getId
```
public long getId()
```
    Returns:
    
    The ID of the form record.
  - getProcessId
```
public String getProcessId()
```
    Returns:
    
    The process ID (i.e. the UUID) of the form record.
  - getSubject
```
public String getSubject()
```
    Returns:
    
    The subject of the form record.
  - isInProgress
```
public boolean isInProgress()
```
    Returns:
    
    Whether the form record is being processed, e.g. when a workflow execution is in progress.
  - isRead
```
public boolean isRead()
```
    Returns:
    
    Whether the form record was read by a user.
  - isSaved
```
public boolean isSaved()
```
    Returns:
    
    Whether the form record is in a saved state.
  - builder
```
public static FormRecordData.Builder builder()
```
    Returns:
    
    A new builder for a FormRecordData.