java.lang.Object
- com.avoka.fc.core.service.form.FormBean

```
public class FormBean
extends Object
```
A java bean to store all associated form property.

Field Summary

Fields
Modifier and Type	Field	Description
`Client`	`client`	The client which this form belongs to.
`String`	`contactEmailXPath`	The form data configuration mapping for the "Contact Email Address" form element
`String`	`contactPhoneXPath`	The form data configuration mapping for the "Contact Phone" form element
`List<Pair<String,String>>`	`dataExtractMappings`	Deprecated. use schemaExtractMappings instead
`boolean`	`enableDuplicate`	whether the form allows duplicate submission
`static String`	`FIT_HEIGHT`	Form view property.
`static String`	`FIT_WIDTH`	Form view property.
`FormArchive`	`formArchive`	Form Archive object
`byte[]`	`formArchiveBytes`	Form Archive bytes array
`String`	`formCode`	Form code
`String`	`formDescription`	Form Description
`String`	`formName`	Form name
`byte[]`	`formTemplateBytes`	Form template bytes array
`String`	`formTemplateFilename`	Form template file name
`String`	`formType`	Form Type
`boolean`	`hasDesktopForm`	FAR has HTML Desktop form (device: desktop)
`boolean`	`hasPdfForm`	FAR has PDF form (target: interactive)
`boolean`	`hasPdfReciept`	FAR has PDF receipt (device: receipt)
`boolean`	`hasPhoneForm`	FAR has HTML Phone form (device: phone)
`boolean`	`hasTabletForm`	FAR has HTML Tablet form (device: tablet)
`static String[]`	`PDF_FORM_VIEWS`	A list of PDF form views.
`String`	`pdfFormView`	the PDF view options for the form
`List<Portal>`	`portals`	The portal which this form is associated with.
`boolean`	`readerExtend`	whether the form is reader extended
`byte[]`	`receiptTemplateBytes`	receipt template bytes array
`String`	`receiptTemplateFilename`	receipt template file name
`String`	`saveChallengeXPath`	The form data configuration mapping for the "Save Challenge Answer" form element
`List<SchemaExtractMapBean>`	`schemaExtractMappings`	the submission data extract mappings that shall be used
`byte[]`	`schemaSeedBytes`	the schema seed bytes array for the form
`String`	`schemaSeedFilename`	the schema seed file name for the form
`String`	`showNavbar`	whether to show navigation bar for the form
`String`	`showScrollbar`	whether to show scroll bar for the form
`String`	`showToolbar`	whether to show tool bar for the form
`boolean`	`supportsOfflineSubmission`	whether the form can render the offline submission response itself
`boolean`	`testFlag`	whether the form shall be in test mode (off by default)
`static String`	`ZOOM_100`	Form view property.

Constructor Summary

Constructors
Constructor Description

FormBean()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isComposerSmartForm()`	Return whether the form template file is an Composer SmartForm.
`boolean`	`isDynamicPdfForm()`	Return whether the form template file is a XFA Dynamic PDF Form.
`boolean`	`isMaestroForm()`	Return whether the form template file is an Maestro Form.
`boolean`	`isOtherDocument()`	Return whether the form template file is an other type of document, e.g.
`boolean`	`isStaticPdfForm()`	Return whether the form template file is a static PDF form.

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

- Field Detail
  - ZOOM_100
```
public static final String ZOOM_100
```
    Form view property. Zoom to 100%
    
    See Also:
    
    Constant Field Values
  - FIT_HEIGHT
```
public static final String FIT_HEIGHT
```
    Form view property. Fit to height
    
    See Also:
    
    Constant Field Values
  - FIT_WIDTH
```
public static final String FIT_WIDTH
```
    Form view property. Fit to width
    
    See Also:
    
    Constant Field Values
  - PDF_FORM_VIEWS
```
public static final String[] PDF_FORM_VIEWS
```
    A list of PDF form views.
  - client
```
public Client client
```
    The client which this form belongs to.
  - portals
```
public List<Portal> portals
```
    The portal which this form is associated with.
  - formArchive
```
public FormArchive formArchive
```
    Form Archive object
  - formArchiveBytes
```
public byte[] formArchiveBytes
```
    Form Archive bytes array
  - formName
```
public String formName
```
    Form name
  - formCode
```
public String formCode
```
    Form code
  - formType
```
public String formType
```
    Form Type
  - formDescription
```
public String formDescription
```
    Form Description
  - formTemplateFilename
```
public String formTemplateFilename
```
    Form template file name
  - formTemplateBytes
```
public byte[] formTemplateBytes
```
    Form template bytes array
  - hasPdfForm
```
public boolean hasPdfForm
```
    FAR has PDF form (target: interactive)
  - hasPdfReciept
```
public boolean hasPdfReciept
```
    FAR has PDF receipt (device: receipt)
  - hasDesktopForm
```
public boolean hasDesktopForm
```
    FAR has HTML Desktop form (device: desktop)
  - hasTabletForm
```
public boolean hasTabletForm
```
    FAR has HTML Tablet form (device: tablet)
  - hasPhoneForm
```
public boolean hasPhoneForm
```
    FAR has HTML Phone form (device: phone)
  - receiptTemplateFilename
```
public String receiptTemplateFilename
```
    receipt template file name
  - receiptTemplateBytes
```
public byte[] receiptTemplateBytes
```
    receipt template bytes array
  - schemaSeedFilename
```
public String schemaSeedFilename
```
    the schema seed file name for the form
  - schemaSeedBytes
```
public byte[] schemaSeedBytes
```
    the schema seed bytes array for the form
  - contactEmailXPath
```
public String contactEmailXPath
```
    The form data configuration mapping for the "Contact Email Address" form element
  - contactPhoneXPath
```
public String contactPhoneXPath
```
    The form data configuration mapping for the "Contact Phone" form element
  - saveChallengeXPath
```
public String saveChallengeXPath
```
    The form data configuration mapping for the "Save Challenge Answer" form element
  - dataExtractMappings
```
@Deprecated
public List<Pair<String,String>> dataExtractMappings
```
    Deprecated.
    use schemaExtractMappings instead
    
    the submission data extract mappings that shall be used (name / XPath pairs)
  - schemaExtractMappings
```
public List<SchemaExtractMapBean> schemaExtractMappings
```
    the submission data extract mappings that shall be used
  - readerExtend
```
public boolean readerExtend
```
    whether the form is reader extended
  - enableDuplicate
```
public boolean enableDuplicate
```
    whether the form allows duplicate submission
  - supportsOfflineSubmission
```
public boolean supportsOfflineSubmission
```
    whether the form can render the offline submission response itself
  - testFlag
```
public boolean testFlag
```
    whether the form shall be in test mode (off by default)
  - pdfFormView
```
public String pdfFormView
```
    the PDF view options for the form
  - showToolbar
```
public String showToolbar
```
    whether to show tool bar for the form
  - showNavbar
```
public String showNavbar
```
    whether to show navigation bar for the form
  - showScrollbar
```
public String showScrollbar
```
    whether to show scroll bar for the form
- Constructor Detail
  - FormBean
```
public FormBean()
```
- Method Detail
  - isDynamicPdfForm
```
public boolean isDynamicPdfForm()
```
    Return whether the form template file is a XFA Dynamic PDF Form.
    
    Returns:
    
    true if the form type is TemplateVersion.FORM_TYPE_DYNAMIC_PDF_FORM
  - isComposerSmartForm
```
public boolean isComposerSmartForm()
```
    Return whether the form template file is an Composer SmartForm.
    
    Returns:
    
    true if the form type is TemplateVersion.FORM_TYPE_COMPOSER_SMARTFORM
  - isMaestroForm
```
public boolean isMaestroForm()
```
    Return whether the form template file is an Maestro Form.
    
    Returns:
    
    true if the form type is TemplateVersion.FORM_TYPE_MAESTRO_FORM
  - isStaticPdfForm
```
public boolean isStaticPdfForm()
```
    Return whether the form template file is a static PDF form.
    
    Returns:
    
    true if the form type is TemplateVersion.FORM_TYPE_STATIC_PDF_FORM
  - isOtherDocument
```
public boolean isOtherDocument()
```
    Return whether the form template file is an other type of document, e.g. Microsoft Word document.
    
    Returns:
    
    true if the form type is TemplateVersion.FORM_TYPE_OTHER_DOCUMENT

Class FormBean

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZOOM_100

FIT_HEIGHT

FIT_WIDTH

PDF_FORM_VIEWS

client

portals

formArchive

formArchiveBytes

formName

formCode

formType

formDescription

formTemplateFilename

formTemplateBytes

hasPdfForm

hasPdfReciept

hasDesktopForm

hasTabletForm

hasPhoneForm

receiptTemplateFilename

receiptTemplateBytes

schemaSeedFilename

schemaSeedBytes

contactEmailXPath

contactPhoneXPath

saveChallengeXPath

dataExtractMappings

schemaExtractMappings

readerExtend

enableDuplicate

supportsOfflineSubmission

testFlag

pdfFormView

showToolbar

showNavbar

showScrollbar

Constructor Detail

FormBean

Method Detail

isDynamicPdfForm

isComposerSmartForm

isMaestroForm

isStaticPdfForm

isOtherDocument