Class BulkEnvelopeStatus

    • Constructor Detail

      • BulkEnvelopeStatus

        public BulkEnvelopeStatus()
    • Method Detail

      • getBatchId

        public String getBatchId()
        Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches..
        Returns:
        batchId
      • setBatchId

        public void setBatchId​(String batchId)
        setBatchId.
      • getBatchSize

        public String getBatchSize()
        The number of items returned in this response..
        Returns:
        batchSize
      • setBatchSize

        public void setBatchSize​(String batchSize)
        setBatchSize.
      • addBulkEnvelopesItem

        public BulkEnvelopeStatus addBulkEnvelopesItem​(BulkEnvelope bulkEnvelopesItem)
        addBulkEnvelopesItem.
        Returns:
        BulkEnvelopeStatus
      • getBulkEnvelopes

        public List<BulkEnvelope> getBulkEnvelopes()
        Reserved: TBD.
        Returns:
        bulkEnvelopes
      • setBulkEnvelopes

        public void setBulkEnvelopes​(List<BulkEnvelope> bulkEnvelopes)
        setBulkEnvelopes.
      • bulkEnvelopesBatchUri

        public BulkEnvelopeStatus bulkEnvelopesBatchUri​(String bulkEnvelopesBatchUri)
        bulkEnvelopesBatchUri.
        Returns:
        BulkEnvelopeStatus
      • getBulkEnvelopesBatchUri

        public String getBulkEnvelopesBatchUri()
        Reserved: TBD.
        Returns:
        bulkEnvelopesBatchUri
      • setBulkEnvelopesBatchUri

        public void setBulkEnvelopesBatchUri​(String bulkEnvelopesBatchUri)
        setBulkEnvelopesBatchUri.
      • getEndPosition

        public String getEndPosition()
        The last position in the result set. .
        Returns:
        endPosition
      • setEndPosition

        public void setEndPosition​(String endPosition)
        setEndPosition.
      • getFailed

        public String getFailed()
        The number of entries with a status of failed. .
        Returns:
        failed
      • setFailed

        public void setFailed​(String failed)
        setFailed.
      • getNextUri

        public String getNextUri()
        The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. .
        Returns:
        nextUri
      • setNextUri

        public void setNextUri​(String nextUri)
        setNextUri.
      • getPreviousUri

        public String getPreviousUri()
        The postal code for the billing address..
        Returns:
        previousUri
      • setPreviousUri

        public void setPreviousUri​(String previousUri)
        setPreviousUri.
      • getQueued

        public String getQueued()
        The number of entries with a status of queued. .
        Returns:
        queued
      • setQueued

        public void setQueued​(String queued)
        setQueued.
      • resultSetSize

        public BulkEnvelopeStatus resultSetSize​(String resultSetSize)
        resultSetSize.
        Returns:
        BulkEnvelopeStatus
      • getResultSetSize

        public String getResultSetSize()
        The number of results returned in this response. .
        Returns:
        resultSetSize
      • setResultSetSize

        public void setResultSetSize​(String resultSetSize)
        setResultSetSize.
      • getSent

        public String getSent()
        The number of entries with a status of sent..
        Returns:
        sent
      • setSent

        public void setSent​(String sent)
        setSent.
      • startPosition

        public BulkEnvelopeStatus startPosition​(String startPosition)
        startPosition.
        Returns:
        BulkEnvelopeStatus
      • getStartPosition

        public String getStartPosition()
        Starting position of the current result set..
        Returns:
        startPosition
      • setStartPosition

        public void setStartPosition​(String startPosition)
        setStartPosition.
      • submittedDate

        public BulkEnvelopeStatus submittedDate​(String submittedDate)
        submittedDate.
        Returns:
        BulkEnvelopeStatus
      • getSubmittedDate

        public String getSubmittedDate()
        .
        Returns:
        submittedDate
      • setSubmittedDate

        public void setSubmittedDate​(String submittedDate)
        setSubmittedDate.
      • totalSetSize

        public BulkEnvelopeStatus totalSetSize​(String totalSetSize)
        totalSetSize.
        Returns:
        BulkEnvelopeStatus
      • getTotalSetSize

        public String getTotalSetSize()
        The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response..
        Returns:
        totalSetSize
      • setTotalSetSize

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