Package com.docusign.webforms.model

Class WebFormInstance

  • All Implemented Interfaces:
    Serializable
    public class WebFormInstance
extends Object
implements Serializable
    An object that contains the Web Form Instance required to render it and its metadata such as created by, created time.
    See Also:
    Serialized Form

    • Constructor Detail

      • WebFormInstance

        public WebFormInstance()

    • Method Detail

      • getFormUrl

        public String getFormUrl()
        Get formUrl.
        Returns:
        formUrl

      • setFormUrl

        public void setFormUrl​(String formUrl)
        setFormUrl.

      • instanceToken

        public WebFormInstance instanceToken​(String instanceToken)
        instanceToken.
        Returns:
        WebFormInstance

      • getInstanceToken

        public String getInstanceToken()
        Get instanceToken.
        Returns:
        instanceToken

      • setInstanceToken

        public void setInstanceToken​(String instanceToken)
        setInstanceToken.

      • tokenExpirationDateTime

        public WebFormInstance tokenExpirationDateTime​(String tokenExpirationDateTime)
        tokenExpirationDateTime.
        Returns:
        WebFormInstance

      • getTokenExpirationDateTime

        public String getTokenExpirationDateTime()
        Get tokenExpirationDateTime.
        Returns:
        tokenExpirationDateTime

      • setTokenExpirationDateTime

        public void setTokenExpirationDateTime​(String tokenExpirationDateTime)
        setTokenExpirationDateTime.

      • getId

        public String getId()
        Get id.
        Returns:
        id

      • setId

        public void setId​(String id)
        setId.

      • getFormId

        public String getFormId()
        Web form from which the instance is created.
        Returns:
        formId

      • setFormId

        public void setFormId​(String formId)
        setFormId.

      • getAccountId

        public String getAccountId()
        Get accountId.
        Returns:
        accountId

      • setAccountId

        public void setAccountId​(String accountId)
        setAccountId.

      • clientUserId

        public WebFormInstance clientUserId​(String clientUserId)
        clientUserId.
        Returns:
        WebFormInstance

      • getClientUserId

        public String getClientUserId()
        Get clientUserId.
        Returns:
        clientUserId

      • setClientUserId

        public void setClientUserId​(String clientUserId)
        setClientUserId.

      • addTagsItem

        public WebFormInstance addTagsItem​(String tagsItem)
        addTagsItem.
        Returns:
        WebFormInstance

      • getTags

        public List<String> getTags()
        List of tags provided by the user with each request. This field is optional..
        Returns:
        tags

      • setTags

        public void setTags​(List<String> tags)
        setTags.

      • getStatus

        public InstanceStatus getStatus()
        Get status.
        Returns:
        status

      • setStatus

        public void setStatus​(InstanceStatus status)
        setStatus.

      • getEnvelopes

        public List<WebFormInstanceEnvelopes> getEnvelopes()
        The associated envelope that is created when the instance is submitted.
        Returns:
        envelopes

      • getInstanceMetadata

        public WebFormInstanceMetadata getInstanceMetadata()
        Get instanceMetadata.
        Returns:
        instanceMetadata

      • setInstanceMetadata

        public void setInstanceMetadata​(WebFormInstanceMetadata instanceMetadata)
        setInstanceMetadata.

      • putFormValuesItem

        public WebFormInstance putFormValuesItem​(String key,
                                         Object formValuesItem)
        putFormValuesItem.
        Returns:
        WebFormInstance

      • getFormValues

        public Map<String,​Object> getFormValues()
        Key-value pairs (where key is the component name and value is the form value) used to create a form instance. For key of type TextBox, Email, Date, Select and RadioButtonGroup the value is of string type. For key of type Number, the value is of number type. For key of type of CheckboxGroup, the value is of type array of string..
        Returns:
        formValues

      • setFormValues

        public void setFormValues​(Map<String,​Object> formValues)
        setFormValues.

      • getBrandId

        public String getBrandId()
        Get brandId.
        Returns:
        brandId

      • setBrandId

        public void setBrandId​(String brandId)
        setBrandId.

      • getRecipients

        public List<WebFormInstanceRecipients> getRecipients()
        The associated envelope that is created when the instance is submitted.
        Returns:
        recipients

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object