Package com.hellosign.openapi.model

Class SubFormFieldRuleAction

java.lang.Object

com.hellosign.openapi.model.SubFormFieldRuleAction

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class SubFormFieldRuleAction
extends java.lang.Object

SubFormFieldRuleAction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubFormFieldRuleAction.TypeEnum	Gets or Sets type

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	JSON_PROPERTY_FIELD_ID
static java.lang.String	JSON_PROPERTY_GROUP_ID
static java.lang.String	JSON_PROPERTY_HIDDEN
static java.lang.String	JSON_PROPERTY_TYPE

Constructor Summary

Constructors

Constructor	Description
SubFormFieldRuleAction()

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.Object>	createFormData()
boolean	equals(java.lang.Object o)	Return true if this SubFormFieldRuleAction object is equal to o.
SubFormFieldRuleAction	fieldId(java.lang.String fieldId)
java.lang.String	getFieldId()	**field_id** or **group_id** is required, but not both.
java.lang.String	getGroupId()	**group_id** or **field_id** is required, but not both.
java.lang.Boolean	getHidden()	`true` to hide the target field when rule is satisfied, otherwise `false`.
SubFormFieldRuleAction.TypeEnum	getType()	Get type
SubFormFieldRuleAction	groupId(java.lang.String groupId)
int	hashCode()
SubFormFieldRuleAction	hidden(java.lang.Boolean hidden)
void	setFieldId(java.lang.String fieldId)
void	setGroupId(java.lang.String groupId)
void	setHidden(java.lang.Boolean hidden)
void	setType(SubFormFieldRuleAction.TypeEnum type)
java.lang.String	toString()
SubFormFieldRuleAction	type(SubFormFieldRuleAction.TypeEnum type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_HIDDEN

public static final java.lang.String JSON_PROPERTY_HIDDEN

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final java.lang.String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_FIELD_ID

public static final java.lang.String JSON_PROPERTY_FIELD_ID

See Also:

Constant Field Values

JSON_PROPERTY_GROUP_ID

public static final java.lang.String JSON_PROPERTY_GROUP_ID

See Also:

Constant Field Values

Constructor Detail

SubFormFieldRuleAction

public SubFormFieldRuleAction()

Method Detail

hidden

public SubFormFieldRuleAction hidden(java.lang.Boolean hidden)

getHidden

@Nonnull
public java.lang.Boolean getHidden()

`true` to hide the target field when rule is satisfied, otherwise `false`.

Returns:

hidden

setHidden

public void setHidden(java.lang.Boolean hidden)

type

public SubFormFieldRuleAction type(SubFormFieldRuleAction.TypeEnum type)

getType

@Nonnull
public SubFormFieldRuleAction.TypeEnum getType()

Get type

Returns:

type

setType

public void setType(SubFormFieldRuleAction.TypeEnum type)

fieldId

public SubFormFieldRuleAction fieldId(java.lang.String fieldId)

getFieldId

@Nullable
public java.lang.String getFieldId()

**field_id** or **group_id** is required, but not both. Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Cannot use with `group_id`. Trigger and action fields must belong to the same signer.

Returns:

fieldId

setFieldId

public void setFieldId(java.lang.String fieldId)

groupId

public SubFormFieldRuleAction groupId(java.lang.String groupId)

getGroupId

@Nullable
public java.lang.String getGroupId()

**group_id** or **field_id** is required, but not both. Must reference the ID of an existing group defined within `form_field_groups`. Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer.

Returns:

groupId

setGroupId

public void setGroupId(java.lang.String groupId)

equals

public boolean equals(java.lang.Object o)

Return true if this SubFormFieldRuleAction 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