FormAccessModeInfo

java.lang.Object
- com.hcl.domino.keep.info.FormAccessModeInfo

```
public class FormAccessModeInfo
extends java.lang.Object
```
Class to hold information about Form mode. This is a state in the workflow at which a form exists, e.g. “Draft”, “Approval”. At different modes a Form will be accessible to different people and different pre- and post-scripts can be run. onLoad runs prior to returning the result for a GET request. onSave runs prior to saving to the database, after applying values from the HTTP request. onSave can do validation or data manipulation. The language used for the manipulation will be defined at the KeepDbInfo object.

Since:

0.7.2

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FormAccessModeInfo.FormAccessModeRules

Nested Classes
Modifier and Type	Class and Description
`static class`	`FormAccessModeInfo.FormAccessModeRules`

Constructor Summary

Constructors
Constructor and Description

FormAccessModeInfo()
Standard constructor

Constructors
Constructor and Description
`FormAccessModeInfo()` Standard constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDeleteAccessFormula()` String formula to define delete access.
`java.lang.String`	`getModeName()` Gets the name associated with this mode
`java.lang.String`	`getOnLoad()` String of formula to be run prior to returning the result for a GET request
`java.lang.String`	`getOnSave()` String of formula to be run after applying request values from a POST / PATCH request and prior to saving to the database
`java.util.Set<java.lang.String>`	`getReadAccessFields()` Subset of fields to return in any GET request
`java.lang.String`	`getReadAccessFormula()` String formula to define read access.
`java.util.List<FormAccessModeInfo.FormAccessModeRules>`	`getValidationRules()` Set of validation rules, with each rule having a formula to process and an error message to return.
`java.util.Set<java.lang.String>`	`getWriteAccessFields()` Subset of fields to accept in any POST / PATCH request
`java.lang.String`	`getWriteAccessFormula()` String formula to define write access.
`boolean`	`hasReadAccessField(java.lang.String key)` Check if a field has read access If NO fields are there it is true
`boolean`	`isAllowAnyField()`
`boolean`	`isComputeWithForm()` Applies the underlying Domino Form’s Input Translation and Input Validation formulas prior to save
`boolean`	`isStrictInput()` Gets whether an error should be thrown if the fields expected for a POST / PATCH are missing.
`void`	`setAllowAnyField(boolean allowAnyField)`
`void`	`setComputeWithForm(boolean computeWithForm)` Sets whether or not to apply the underlying Domino Form’s Input Translation and Input Validation formulas prior to save
`void`	`setDeleteAccessFormula(java.lang.String deleteAccessFormula)` Sets formula to define delete access, e.g.
`void`	`setModeName(java.lang.String modeName)` Sets the name to associate this mode to
`void`	`setOnLoad(java.lang.String onLoad)` Sets the formula to run prior to returning result for a GET request
`void`	`setOnSave(java.lang.String onSave)` Sets the formula to be run after applying request values from a POST / PATCH request and prior to saving to the database
`FormAccessModeInfo`	`setReadAccessFields(java.util.Collection<java.lang.String> readAccessFields)` Sets the fields to return in any GET request
`FormAccessModeInfo`	`setReadAccessFormula(java.lang.String readAccessFormula)` Sets formula to define write access, e.g.
`FormAccessModeInfo`	`setStrictInput(boolean strictInput)` Sets whether an error should be thrown if the fields expected for a POST / PATCH are missing.
`FormAccessModeInfo`	`setValidationRules(java.util.Collection<FormAccessModeInfo.FormAccessModeRules> validationRules)` Sets the validation rules to process in a POST / PATCH request
`FormAccessModeInfo`	`setWriteAccessFields(java.util.Collection<java.lang.String> writeAccessFields)` Sets the fields to accept in any POST / PATCH request
`FormAccessModeInfo`	`setWriteAccessFormula(java.lang.String writeAccessFormula)` Sets formula to define write access, e.g.
`io.vertx.core.json.JsonObject`	`toJson()`

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

- Constructor Detail
  - FormAccessModeInfo
```
public FormAccessModeInfo()
```
    Standard constructor
- Method Detail
  - getDeleteAccessFormula
```
public java.lang.String getDeleteAccessFormula()
```
    String formula to define delete access.
    
    Returns:
    
    formula to restrict delete access to the mode
  - getModeName
```
public java.lang.String getModeName()
```
    Gets the name associated with this mode
    
    Returns:
    
    mode name
  - getOnLoad
```
public java.lang.String getOnLoad()
```
    String of formula to be run prior to returning the result for a GET request
    
    Returns:
    
    formula to run
  - getOnSave
```
public java.lang.String getOnSave()
```
    String of formula to be run after applying request values from a POST / PATCH request and prior to saving to the database
    
    Returns:
    
    formula to run
  - getReadAccessFields
```
public java.util.Set<java.lang.String> getReadAccessFields()
```
    Subset of fields to return in any GET request
    
    Returns:
    
    list of fields to return
  - getReadAccessFormula
```
public java.lang.String getReadAccessFormula()
```
    String formula to define read access.
    
    Returns:
    
    formula to restrict read access to the mode
  - getValidationRules
```
public java.util.List<FormAccessModeInfo.FormAccessModeRules> getValidationRules()
```
    Set of validation rules, with each rule having a formula to process and an error message to return. Formulas are in DQL format
    
    Returns:
    
    list of validation rules
  - getWriteAccessFields
```
public java.util.Set<java.lang.String> getWriteAccessFields()
```
    Subset of fields to accept in any POST / PATCH request
    
    Returns:
    
    list of fields to accept
  - getWriteAccessFormula
```
public java.lang.String getWriteAccessFormula()
```
    String formula to define write access.
    
    Returns:
    
    formula to restrict write access to the mode
  - hasReadAccessField
```
public boolean hasReadAccessField(java.lang.String key)
```
    Check if a field has read access If NO fields are there it is true
    Parameters:
    key -
    
    Field Name
    Returns:
    
    true if the field is configured
  - isAllowAnyField
```
public boolean isAllowAnyField()
```
    Returns:
    
    the allowAnyField
  - isComputeWithForm
```
public boolean isComputeWithForm()
```
    Applies the underlying Domino Form’s Input Translation and Input Validation formulas prior to save
    
    Returns:
    
    whether to run {code computeWithForm} method on the document before save
  - isStrictInput
```
public boolean isStrictInput()
```
    Gets whether an error should be thrown if the fields expected for a POST / PATCH are missing. If false, any additional fields supplied are just dropped.
    
    Returns:
    
    method for validating JSON input
  - setAllowAnyField
```
public void setAllowAnyField(boolean allowAnyField)
```
    Parameters:
    
    allowAnyField - the allowAnyField to set
  - setComputeWithForm
```
public void setComputeWithForm(boolean computeWithForm)
```
    Sets whether or not to apply the underlying Domino Form’s Input Translation and Input Validation formulas prior to save
    
    Parameters:
    
    computeWithForm - whether to run {code computeWithForm} method on the document before save
  - setDeleteAccessFormula
```
public void setDeleteAccessFormula(java.lang.String deleteAccessFormula)
```
    Sets formula to define delete access, e.g.
```
@IsMember("[Finance]";@UserRoles);

Result: Mode is only accessible to users allocated the Finance role.

!@IsNotMember("[R&D]":"[Admin]";@UserRoles);

Result: Mode is only accessible to users in either R&D or Admin roles.

@IsMember("Marketing Group"; @UserNamesList);

Result: Mode is only accessible to users or groups in the "Marketing Group" group

@IsMember("*\/OU=HR\/O=MyCorp"; @UserNamesList);

Result: Mode is only accessible to users with the Organization Unit "HR" and Orgnization "MyCorp" in their username
```
    Parameters:
    
    deleteAccessFormula -
  - setModeName
```
public void setModeName(@Nonnull
                        java.lang.String modeName)
```
    Sets the name to associate this mode to
    
    Parameters:
    
    modeName - name of the mode
  - setOnLoad
```
public void setOnLoad(java.lang.String onLoad)
```
    Sets the formula to run prior to returning result for a GET request
    
    Parameters:
    
    onLoad - formula to run
  - setOnSave
```
public void setOnSave(java.lang.String onSave)
```
    Sets the formula to be run after applying request values from a POST / PATCH request and prior to saving to the database
    
    Parameters:
    
    onSave - formula to reun
  - setReadAccessFields
```
public FormAccessModeInfo setReadAccessFields(java.util.Collection<java.lang.String> readAccessFields)
```
    Sets the fields to return in any GET request
    
    Parameters:
    
    readAccessFields - list of fields to return
    
    Returns:
    
    fluent
  - setReadAccessFormula
```
public FormAccessModeInfo setReadAccessFormula(java.lang.String readAccessFormula)
```
    Sets formula to define write access, e.g.
```
@IsMember("[Finance]";@UserRoles);

Result: Mode is only accessible to users allocated the Finance role.

!@IsNotMember("[R&D]":"[Admin]";@UserRoles);

Result: Mode is only accessible to users in either R&D or Admin roles.

@IsMember("Marketing Group"; @UserNamesList);

Result: Mode is only accessible to users or groups in the "Marketing Group" group

@IsMember("*\/OU=HR\/O=MyCorp"; @UserNamesList);

Result: Mode is only accessible to users with the Organization Unit "HR" and Orgnization "MyCorp" in their username
```
    Parameters:
    
    readAccessFormula -
    
    Returns:
    
    fluent
  - setStrictInput
```
public FormAccessModeInfo setStrictInput(boolean strictInput)
```
    Sets whether an error should be thrown if the fields expected for a POST / PATCH are missing. If false, any additional fields supplied are just dropped.
    
    Parameters:
    
    strictInput - method for validating JSON input
    
    Returns:
    
    fluent
  - setValidationRules
```
public FormAccessModeInfo setValidationRules(java.util.Collection<FormAccessModeInfo.FormAccessModeRules> validationRules)
```
    Sets the validation rules to process in a POST / PATCH request
    
    Parameters:
    
    validationRules - list of fields to accept
    
    Returns:
    
    fluent
  - setWriteAccessFields
```
public FormAccessModeInfo setWriteAccessFields(java.util.Collection<java.lang.String> writeAccessFields)
```
    Sets the fields to accept in any POST / PATCH request
    
    Parameters:
    
    writeAccessFields - list of fields to accept
    
    Returns:
    
    fluent
  - setWriteAccessFormula
```
public FormAccessModeInfo setWriteAccessFormula(java.lang.String writeAccessFormula)
```
    Sets formula to define write access, e.g.
```
@IsMember("[Finance]";@UserRoles);

Result: Mode is only accessible to users allocated the Finance role.

!@IsNotMember("[R&D]":"[Admin]";@UserRoles);

Result: Mode is only accessible to users in either R&D or Admin roles.

@IsMember("Marketing Group"; @UserNamesList);

Result: Mode is only accessible to users or groups in the "Marketing Group" group

@IsMember("*\/OU=HR\/O=MyCorp"; @UserNamesList);

Result: Mode is only accessible to users with the Organization Unit "HR" and Orgnization "MyCorp" in their username
```
    Parameters:
    
    writeAccessFormula -
    
    Returns:
    
    fluent
  - toJson
```
public io.vertx.core.json.JsonObject toJson()
```
    Returns:
    
    JSON representation of the form mode

Class FormAccessModeInfo

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FormAccessModeInfo

Method Detail

getDeleteAccessFormula

getModeName

getOnLoad

getOnSave

getReadAccessFields

getReadAccessFormula

getValidationRules

getWriteAccessFields

getWriteAccessFormula

hasReadAccessField

isAllowAnyField

isComputeWithForm

isStrictInput

setAllowAnyField

setComputeWithForm

setDeleteAccessFormula

setModeName

setOnLoad

setOnSave

setReadAccessFields

setReadAccessFormula

setStrictInput

setValidationRules

setWriteAccessFields

setWriteAccessFormula

toJson