AFOptions (AEM Forms API)

java.lang.Object
- com.adobe.aemforms.fm.model.FormOptions
- - com.adobe.aemforms.fm.model.AFOptions

```
public class AFOptions
extends FormOptions
```
AFOptions represents the Adaptive Form Configurable properties that will be honored while creating Adaptive Form through FormGenerationService.

Constructor Summary

Constructors
Constructor and Description

AFOptions()

Constructors
Constructor and Description
`AFOptions()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAdobeSignConfig()` Returns the path of the adobe sign configuration associated to the form.
`String`	`getAFGenerator()` Returns the software package used for creating adaptive form.
`String`	`getAfTemplatePath()` Returns the Repository path of the Adaptive Form template used for creating the form
`String`	`getAfThemePath()` Returns the Repository path of the Adaptive Form theme used for creating the form
`String[]`	`getCloudServiceConfigs()` Returns the array of all cloud services configured with the form.
`Map<String,Object>`	`getCustomPropertiesMap()` Returns the map of custom properties that are added by the service responsible for the creation of the Adaptive Form
`String`	`getDorTemplatePath()`
`String`	`getDorType()`
`String`	`getFormModelRef()` Returns the repository path of the file which will be used to model Adaptive Form
`String`	`getFormModelRoot()` Returns the Repository path of the form model root element.
`FormModel`	`getFormModelType()` Returns the form model type used for creating adaptive form.
`String`	`getIsElectronicSignatureEnabled()` Returns True if adobe sign is enabled for the form.
`String`	`getXdpRef()` Deprecated. Use getFormModelRef instead. Returns the Repository path of the Form Template.
`boolean`	`isAdobeSignEnabled()` Deprecated. use getIsElectronicSignatureEnabled instead. Returns if adobe sign is enabled for the form.
`void`	`setAdobeSignConfig(String adobeSignConfig)` Sets the path of the adobe sign configuration associated to the form.
`void`	`setAdobeSignEnabled(boolean adobeSignEnabled)` Deprecated. use setIsElectronicSignatureEnabled instead Sets if adobe sign needs to be enabled for the form.
`void`	`setAFGenerator(String afGenerator)` Sets the software package used for creating adaptive form.
`void`	`setAfTemplatePath(String afTemplatePath)` Set the Repository path of the Adaptive Form template used for creating the form.
`void`	`setAfThemePath(String afThemePath)` Set the Repository path of the Adaptive Form theme used for creating the form.
`void`	`setCloudServiceConfigs(String[] cloudServiceConfigs)` Sets the array of all cloud services configured with the form.
`void`	`setCustomPropertiesMap(Map<String,Object> customPropertiesMap)` This API sets the key value pairs of custom properties that can be used by services or tools which create an Adaptive Form
`void`	`setDorTemplatePath(String dorTemplatePath)`
`void`	`setDorType(String dorType)`
`void`	`setFormModelRef(String formModelRef)` Sets the repository path of the Form Model file which to be used for creating Adaptive Form
`void`	`setFormModelRoot(String formModelRoot)` Sets the form model root element to be picked for modeling the Adaptive Form.
`void`	`setFormModelType(FormModel formModel)` Sets the type of form model to use for creating adaptive form.
`void`	`setIsElectronicSignatureEnabled(String isElectronicSignatureEnabled)` Sets "_useSignedPdf" to "true" if "Electronic Signature" is enabled in template
`void`	`setXdpRef(String xdpRef)` Deprecated. User setFormModelRef instead. Set the Repository path of the Form Template to model the Adaptive Form.

Methods inherited from class com.adobe.aemforms.fm.model.FormOptions
getAnalyticsEnabled, getDescription, getFormLocation, getName, getNameConflictAction, getTags, getTitle, setAnalyticsEnabled, setDescription, setFormLocation, setName, setNameConflictAction, setTags, setTitle

- Constructor Detail
  - AFOptions
```
public AFOptions()
```
- Method Detail
  - getAfTemplatePath
```
public String getAfTemplatePath()
```
    Returns the Repository path of the Adaptive Form template used for creating the form
    
    Returns:
    
    String representing the Repository path of the Adaptive Form template.
  - setAfTemplatePath
```
public void setAfTemplatePath(String afTemplatePath)
```
    Set the Repository path of the Adaptive Form template used for creating the form. It is mandatory to set afTemplatePath for Adaptive Form creation.
    
    Parameters:
    
    afTemplatePath - String representing a valid Repository path of the Adaptive Form template.
  - getAfThemePath
```
public String getAfThemePath()
```
    Returns the Repository path of the Adaptive Form theme used for creating the form
    
    Returns:
    
    String representing the Repository path of the Adaptive Form theme.
  - setAfThemePath
```
public void setAfThemePath(String afThemePath)
```
    Set the Repository path of the Adaptive Form theme used for creating the form.
    
    Parameters:
    
    afThemePath - String representing a valid Repository path of the Adaptive Form theme.
  - getXdpRef
```
@Deprecated
public String getXdpRef()
```
    Deprecated. Use getFormModelRef instead. Returns the Repository path of the Form Template.
    
    Returns:
    
    String representing a Repository path of the Form Template.
  - setXdpRef
```
@Deprecated
public void setXdpRef(String xdpRef)
```
    Deprecated. User setFormModelRef instead. Set the Repository path of the Form Template to model the Adaptive Form.
    
    Parameters:
    
    xdpRef - String representing a valid Repository path of the Form Template.
  - getFormModelRoot
```
public String getFormModelRoot()
```
    Returns the Repository path of the form model root element.
    
    Returns:
    
    String representing the form model root element.
  - setFormModelRoot
```
public void setFormModelRoot(String formModelRoot)
```
    Sets the form model root element to be picked for modeling the Adaptive Form.
    
    Parameters:
    
    formModelRoot - String representing valid form model root.
  - getFormModelRef
```
public String getFormModelRef()
```
    Returns the repository path of the file which will be used to model Adaptive Form
    
    Returns:
    
    formModelRef
  - setFormModelRef
```
public void setFormModelRef(String formModelRef)
```
    Sets the repository path of the Form Model file which to be used for creating Adaptive Form
  - getAFGenerator
```
public String getAFGenerator()
```
    Returns the software package used for creating adaptive form.
    
    Returns:
    
    name of software package being used for creating adaptive form.
  - getFormModelType
```
public FormModel getFormModelType()
```
    Returns the form model type used for creating adaptive form.
    
    Returns:
    
    FormModel specifying type of model being used for creating adaptive form.
  - setFormModelType
```
public void setFormModelType(FormModel formModel)
```
    Sets the type of form model to use for creating adaptive form.
    
    Parameters:
    
    formModel - FormModel specifying type of model to be used for creating adaptive form.
  - setAFGenerator
```
public void setAFGenerator(String afGenerator)
```
    Sets the software package used for creating adaptive form.
    
    Parameters:
    
    afGenerator - specifying name of software package
  - getDorTemplatePath
```
public String getDorTemplatePath()
```
  - setDorTemplatePath
```
public void setDorTemplatePath(String dorTemplatePath)
```
  - getDorType
```
public String getDorType()
```
  - setDorType
```
public void setDorType(String dorType)
```
  - getCloudServiceConfigs
```
public String[] getCloudServiceConfigs()
```
    Returns the array of all cloud services configured with the form.
    
    Returns:
    
    the array of all cloud services configured with the form.
  - setCloudServiceConfigs
```
public void setCloudServiceConfigs(String[] cloudServiceConfigs)
```
    Sets the array of all cloud services configured with the form.
    
    Parameters:
    
    cloudServiceConfigs - the array of all cloud services configured with the form.
  - isAdobeSignEnabled
```
@Deprecated
public boolean isAdobeSignEnabled()
```
    Deprecated. use getIsElectronicSignatureEnabled instead. Returns if adobe sign is enabled for the form.
    
    Returns:
    
    True if adobe sign needs to be enabled for the form.
  - setAdobeSignEnabled
```
@Deprecated
public void setAdobeSignEnabled(boolean adobeSignEnabled)
```
    Deprecated. use setIsElectronicSignatureEnabled instead Sets if adobe sign needs to be enabled for the form.
    
    Parameters:
    
    adobeSignEnabled - True if adobe sign needs to be enabled for the form.
  - getAdobeSignConfig
```
public String getAdobeSignConfig()
```
    Returns the path of the adobe sign configuration associated to the form.
    
    Returns:
    
    The path of the adobe sign configuration associated to the form.
  - setAdobeSignConfig
```
public void setAdobeSignConfig(String adobeSignConfig)
```
    Sets the path of the adobe sign configuration associated to the form.
    
    Parameters:
    
    adobeSignConfig - The path of the adobe sign configuration associated to the form.
  - getIsElectronicSignatureEnabled
```
public String getIsElectronicSignatureEnabled()
```
    Returns True if adobe sign is enabled for the form.
    
    Returns:
    
    "True" if adobe sign needs to be enabled for the form.
  - setIsElectronicSignatureEnabled
```
public void setIsElectronicSignatureEnabled(String isElectronicSignatureEnabled)
```
    Sets "_useSignedPdf" to "true" if "Electronic Signature" is enabled in template
    
    Parameters:
    
    isElectronicSignatureEnabled - "true" if adobe sign needs to be enabled for the form. By default this set to null, if not null set it to true or false, that is expected.
  - getCustomPropertiesMap
```
public Map<String,Object> getCustomPropertiesMap()
```
    Returns the map of custom properties that are added by the service responsible for the creation of the Adaptive Form
    
    Returns:
    
    customPropertiesMap
  - setCustomPropertiesMap
```
public void setCustomPropertiesMap(Map<String,Object> customPropertiesMap)
```
    This API sets the key value pairs of custom properties that can be used by services or tools which create an Adaptive Form
    
    Parameters:
    
    customPropertiesMap -

Class AFOptions

Constructor Summary

Method Summary

Methods inherited from class com.adobe.aemforms.fm.model.FormOptions

Constructor Detail

AFOptions

Method Detail

getAfTemplatePath

setAfTemplatePath

getAfThemePath

setAfThemePath

getXdpRef

setXdpRef

getFormModelRoot

setFormModelRoot

getFormModelRef

setFormModelRef

getAFGenerator

getFormModelType

setFormModelType

setAFGenerator

getDorTemplatePath

setDorTemplatePath

getDorType

setDorType

getCloudServiceConfigs

setCloudServiceConfigs

isAdobeSignEnabled

setAdobeSignEnabled

getAdobeSignConfig

setAdobeSignConfig

getIsElectronicSignatureEnabled

setIsElectronicSignatureEnabled

getCustomPropertiesMap

setCustomPropertiesMap