Class FolderItem


  • public class FolderItem
    extends Object
    FolderItem.
    • Constructor Detail

      • FolderItem

        public FolderItem()
    • Method Detail

      • completedDateTime

        public FolderItem completedDateTime​(String completedDateTime)
        completedDateTime.
        Returns:
        FolderItem
      • getCompletedDateTime

        public String getCompletedDateTime()
        Specifies the date and time this item was completed..
        Returns:
        completedDateTime
      • setCompletedDateTime

        public void setCompletedDateTime​(String completedDateTime)
        setCompletedDateTime.
      • createdDateTime

        public FolderItem createdDateTime​(String createdDateTime)
        createdDateTime.
        Returns:
        FolderItem
      • getCreatedDateTime

        public String getCreatedDateTime()
        Indicates the date and time the item was created..
        Returns:
        createdDateTime
      • setCreatedDateTime

        public void setCreatedDateTime​(String createdDateTime)
        setCreatedDateTime.
      • addCustomFieldsItem

        public FolderItem addCustomFieldsItem​(CustomFieldV2 customFieldsItem)
        addCustomFieldsItem.
        Returns:
        FolderItem
      • getCustomFields

        public List<CustomFieldV2> getCustomFields()
        An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters..
        Returns:
        customFields
      • setCustomFields

        public void setCustomFields​(List<CustomFieldV2> customFields)
        setCustomFields.
      • description

        public FolderItem description​(String description)
        description.
        Returns:
        FolderItem
      • getDescription

        public String getDescription()
        .
        Returns:
        description
      • setDescription

        public void setDescription​(String description)
        setDescription.
      • envelopeId

        public FolderItem envelopeId​(String envelopeId)
        envelopeId.
        Returns:
        FolderItem
      • getEnvelopeId

        public String getEnvelopeId()
        The envelope ID of the envelope status that failed to post..
        Returns:
        envelopeId
      • setEnvelopeId

        public void setEnvelopeId​(String envelopeId)
        setEnvelopeId.
      • envelopeUri

        public FolderItem envelopeUri​(String envelopeUri)
        envelopeUri.
        Returns:
        FolderItem
      • getEnvelopeUri

        public String getEnvelopeUri()
        Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes..
        Returns:
        envelopeUri
      • setEnvelopeUri

        public void setEnvelopeUri​(String envelopeUri)
        setEnvelopeUri.
      • is21CFRPart11

        public FolderItem is21CFRPart11​(String is21CFRPart11)
        is21CFRPart11.
        Returns:
        FolderItem
      • getIs21CFRPart11

        public String getIs21CFRPart11()
        When set to **true**, indicates that this module is enabled on the account..
        Returns:
        is21CFRPart11
      • setIs21CFRPart11

        public void setIs21CFRPart11​(String is21CFRPart11)
        setIs21CFRPart11.
      • isSignatureProviderEnvelope

        public FolderItem isSignatureProviderEnvelope​(String isSignatureProviderEnvelope)
        isSignatureProviderEnvelope.
        Returns:
        FolderItem
      • getIsSignatureProviderEnvelope

        public String getIsSignatureProviderEnvelope()
        .
        Returns:
        isSignatureProviderEnvelope
      • setIsSignatureProviderEnvelope

        public void setIsSignatureProviderEnvelope​(String isSignatureProviderEnvelope)
        setIsSignatureProviderEnvelope.
      • lastModified

        public FolderItem lastModified​(String lastModified)
        lastModified.
        Returns:
        FolderItem
      • getLastModified

        public String getLastModified()
        .
        Returns:
        lastModified
      • setLastModified

        public void setLastModified​(String lastModified)
        setLastModified.
      • getName

        public String getName()
        .
        Returns:
        name
      • setName

        public void setName​(String name)
        setName.
      • ownerName

        public FolderItem ownerName​(String ownerName)
        ownerName.
        Returns:
        FolderItem
      • getOwnerName

        public String getOwnerName()
        Name of the envelope owner..
        Returns:
        ownerName
      • setOwnerName

        public void setOwnerName​(String ownerName)
        setOwnerName.
      • pageCount

        public FolderItem pageCount​(Integer pageCount)
        pageCount.
        Returns:
        FolderItem
      • getPageCount

        public Integer getPageCount()
        .
        Returns:
        pageCount
      • setPageCount

        public void setPageCount​(Integer pageCount)
        setPageCount.
      • password

        public FolderItem password​(String password)
        password.
        Returns:
        FolderItem
      • getPassword

        public String getPassword()
        .
        Returns:
        password
      • setPassword

        public void setPassword​(String password)
        setPassword.
      • senderEmail

        public FolderItem senderEmail​(String senderEmail)
        senderEmail.
        Returns:
        FolderItem
      • getSenderEmail

        public String getSenderEmail()
        .
        Returns:
        senderEmail
      • setSenderEmail

        public void setSenderEmail​(String senderEmail)
        setSenderEmail.
      • senderName

        public FolderItem senderName​(String senderName)
        senderName.
        Returns:
        FolderItem
      • getSenderName

        public String getSenderName()
        Name of the envelope sender..
        Returns:
        senderName
      • setSenderName

        public void setSenderName​(String senderName)
        setSenderName.
      • sentDateTime

        public FolderItem sentDateTime​(String sentDateTime)
        sentDateTime.
        Returns:
        FolderItem
      • getSentDateTime

        public String getSentDateTime()
        The date and time the envelope was sent..
        Returns:
        sentDateTime
      • setSentDateTime

        public void setSentDateTime​(String sentDateTime)
        setSentDateTime.
      • shared

        public FolderItem shared​(String shared)
        shared.
        Returns:
        FolderItem
      • getShared

        public String getShared()
        When set to **true**, this custom tab is shared..
        Returns:
        shared
      • setShared

        public void setShared​(String shared)
        setShared.
      • status

        public FolderItem status​(String status)
        status.
        Returns:
        FolderItem
      • getStatus

        public String getStatus()
        Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
        Returns:
        status
      • setStatus

        public void setStatus​(String status)
        setStatus.
      • subject

        public FolderItem subject​(String subject)
        subject.
        Returns:
        FolderItem
      • getSubject

        public String getSubject()
        .
        Returns:
        subject
      • setSubject

        public void setSubject​(String subject)
        setSubject.
      • templateId

        public FolderItem templateId​(String templateId)
        templateId.
        Returns:
        FolderItem
      • getTemplateId

        public String getTemplateId()
        The unique identifier of the template. If this is not provided, DocuSign will generate a value. .
        Returns:
        templateId
      • setTemplateId

        public void setTemplateId​(String templateId)
        setTemplateId.
      • getUri

        public String getUri()
        .
        Returns:
        uri
      • setUri

        public void setUri​(String uri)
        setUri.
      • 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