Sensibill Core/com.getsensibill.core.apimodule.documents/DocumentStatus

DocumentStatus

enum DocumentStatus : Enum<DocumentStatus> , KeyedEnum

Enum representing the status of a DraftDocumentEntity.

Below one can find a simple representation of the same flow, represented as document statuses:

       +------+------+
       | INITIALIZED |  <- Validation is run before initializing, an attempt won't be made if the input is invalid
       +------+------+
              |
              |<--------------------------------+--------------------------------------------------+
              |                                 |                                                  |
              |                  +--------------+---------------+                                  |
              |                  | UPLOADING_PAUSED_NO_INTERNET |                       <retry count not reached>
              v                  +--------------+---------------+                                  |
        +-----+-----+                           |                                    +-------------+-------------+
        | UPLOADING +---------------------------+--------------------+-------------->| UPLOAD_FAILED_RECOVERABLE |
        +-----+-----+                                                |               +-------------+-------------+
              |                                                      |                             |
              v                                                      |                    <retry count reached>
        +-----+-----+                                                |                             |
        | UPLOADED  |                                                |                             |
        +-----+-----+                                                |                             |
              |<----------+-------------------------+                |                             |
              |           |                         |                |                             |
              | +---------+---------+ +-------------+--------------+ |                             |
              | | POLLING_TIMED_OUT | | POLLING_PAUSED_NO_INTERNET | |                             |
              v +---------+---------+ +-------------+--------------+ |                             |
        +-----+-----+     |                         |                |                             |
        |  POLLING  +-----+-------------------------+                |                             |
        +-----+-----+                                                |                             |
              |                                                      |                             |
              |----------------------+                               |                             |
              |                      |                               |                             |
              |                      |                               |                             |
              vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv  FINAL STATES  vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
              |                      |                               |                             |
              |                      |                               |                             |
              v                      v                               v                             v
    +---------+---------+  +---------+---------+      +--------------+--------------+ +------------+------------+
    | PROCESSED_SUCCESS |  | PROCESSED_FAILED  |      | UPLOAD_FAILED_UNRECOVERABLE | | REACHED_MAX_RETRY_COUNT |
    +---------+---------+  +---------+---------+      +--------------+--------------+ +------------+------------+

Entries

INITIALIZED

DraftDocumentEntity has been created in the DraftDocumentDatabase. This status is the default status set when the entity is created and inserted.

UPLOADING

DraftDocumentEntity has been begun the upload step which involves posting to the API and awaiting a response. This status is set as soon as the upload process begins.

UPLOADING_PAUSED_NO_INTERNET

DraftDocumentEntity has begun the upload step, but has no internet access to continue. This state is considered recoverable and will be tried again the next time network is recovered.

UPLOADED

DraftDocumentEntity has been uploaded to the server and now qualifies to be polled. This status is set immediately after we receive a successful upload response from the API.

UPLOAD_FAILED_RECOVERABLE

DraftDocumentEntity has failed to upload with what is deemed as recoverable error. If recoverable, it can be included in future upload attempts.

UPLOAD_FAILED_UNRECOVERABLE

DraftDocumentEntity has failed to upload with what is deemed as unrecoverable error. The DocumentUploadWorker will not attempt re-upload it.

POLLING

DraftDocumentEntity has been uploaded to the API, and is now being actively long polled.

POLLING_TIMED_OUT

DraftDocumentEntity has been uploaded to the API, and is now being actively long polled, but has timed out. It will try again until a new state is reached.

POLLING_PAUSED_NO_INTERNET

DraftDocumentEntity has been uploaded to the API, and is now being actively long polled, but while polling the network was lost and could not be continued. This state is considered recoverable and will be tried again the next time network is recovered.

REACHED_MAX_RETRY_COUNT

DraftDocumentEntity has reached its maximum retry count while uploading or polling. It will not attempt anymore retries.

PROCESSED_SUCCESS

DraftDocumentEntity has successfully been long polled and has returned with a valid response

PROCESSED_FAILED

DraftDocumentEntity has returned with an invalid response while long polling. It will not try any additional attempts.

Types

Companion

object Companion

Properties

isFinal

val isFinal: Boolean = false

key

open override val key: String

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): DocumentStatus

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<DocumentStatus>

Returns an array containing the constants of this enum type, in the order they're declared.