Class SubFormFieldRuleTrigger


  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
    public class SubFormFieldRuleTrigger
    extends java.lang.Object
    SubFormFieldRuleTrigger
    • Field Detail

      • JSON_PROPERTY_ID

        public static final java.lang.String JSON_PROPERTY_ID
        See Also:
        Constant Field Values
      • JSON_PROPERTY_OPERATOR

        public static final java.lang.String JSON_PROPERTY_OPERATOR
        See Also:
        Constant Field Values
      • JSON_PROPERTY_VALUE

        public static final java.lang.String JSON_PROPERTY_VALUE
        See Also:
        Constant Field Values
      • JSON_PROPERTY_VALUES

        public static final java.lang.String JSON_PROPERTY_VALUES
        See Also:
        Constant Field Values
    • Constructor Detail

      • SubFormFieldRuleTrigger

        public SubFormFieldRuleTrigger()
    • Method Detail

      • getId

        @Nonnull
        public java.lang.String getId()
        Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer.
        Returns:
        id
      • setId

        public void setId​(java.lang.String id)
      • getOperator

        @Nonnull
        public SubFormFieldRuleTrigger.OperatorEnum getOperator()
        Different field types allow different `operator` values: - Field type of **text**: - **is**: exact match - **not**: not exact match - **match**: regular expression, without /. Example: - OK `[a-zA-Z0-9]` - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**: - **is**: exact match, single value - **not**: not exact match, single value - **any**: exact match, array of values. - **none**: not exact match, array of values. - Field type of **checkbox**: - **is**: exact match, single value - **not**: not exact match, single value - Field type of **radio**: - **is**: exact match, single value - **not**: not exact match, single value
        Returns:
        operator
      • getValue

        @Nullable
        public java.lang.String getValue()
        **value** or **values** is required, but not both. The value to match against **operator**. - When **operator** is one of the following, **value** must be `String`: - `is` - `not` - `match` Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1`
        Returns:
        value
      • setValue

        public void setValue​(java.lang.String value)
      • getValues

        @Nullable
        public java.util.List<java.lang.String> getValues()
        **values** or **value** is required, but not both. The values to match against **operator** when it is one of the following: - `any` - `none`
        Returns:
        values
      • setValues

        public void setValues​(java.util.List<java.lang.String> values)
      • equals

        public boolean equals​(java.lang.Object o)
        Return true if this SubFormFieldRuleTrigger object is equal to o.
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • createFormData

        public java.util.Map<java.lang.String,​java.lang.Object> createFormData()
                                                                              throws ApiException
        Throws:
        ApiException