Class StatusJson

java.lang.Object
com.blackberry.workspaces.sdk.api.json.BaseJson
com.blackberry.workspaces.sdk.api.json.StatusJson
All Implemented Interfaces:
Serializable

public class StatusJson
extends BaseJson
A command status
See Also:
Serialized Form
  • Constructor Details

  • Method Details

    • getErrorText

      public String getErrorText()
      String with explanatory text in case of error.
      Returns:
      String with explanatory text in case of error.
    • setErrorText

      public void setErrorText​(String errorText)
      String with explanatory text in case of error.
      Parameters:
      errorText - String with explanatory text in case of error.
    • getDocumentState

      public DocumentStatusForApi getDocumentState()
      Representing status: completed, in progress, error.
      Returns:
      Representing status: completed, in progress, error.
    • setDocumentState

      public void setDocumentState​(DocumentStatusForApi documentState)
      Representing status: completed, in progress, error.
      Parameters:
      documentState - Representing status: completed, in progress, error.
    • getStatusCode

      public Integer getStatusCode()
      Integer representation of the status. Following is the list of possible values: 0 - COMPLETED 1 - CREATED 2 - CONVERTED_ONLY 3 - SEALED_ONLY 10 - UPLOAD_STARTED 11 - UPLOAD_FAILED 20 - CONVERSION_STARTED 21 - CONVERSION_FAILED 22 - CONVERSION_FINISHED 24 - SUBMISSION_STARTED 25 - SUBMISSION_FAILED 30 - SEAL_STARTED 31 - SEALING_FAILED 32 - SEAL_FINISHED 41 - DOCUMENT_ALREADY_SEALED
      Returns:
      Integer representation of the status. Following is the list of possible values: 0 - COMPLETED 1 - CREATED 2 - CONVERTED_ONLY 3 - SEALED_ONLY 10 - UPLOAD_STARTED 11 - UPLOAD_FAILED 20 - CONVERSION_STARTED 21 - CONVERSION_FAILED 22 - CONVERSION_FINISHED 24 - SUBMISSION_STARTED 25 - SUBMISSION_FAILED 30 - SEAL_STARTED 31 - SEALING_FAILED 32 - SEAL_FINISHED 41 - DOCUMENT_ALREADY_SEALED
    • setStatusCode

      public void setStatusCode​(Integer statusCode)
      Integer representation of the status. Following is the list of possible values: 0 - COMPLETED 1 - CREATED 2 - CONVERTED_ONLY 3 - SEALED_ONLY 10 - UPLOAD_STARTED 11 - UPLOAD_FAILED 20 - CONVERSION_STARTED 21 - CONVERSION_FAILED 22 - CONVERSION_FINISHED 24 - SUBMISSION_STARTED 25 - SUBMISSION_FAILED 30 - SEAL_STARTED 31 - SEALING_FAILED 32 - SEAL_FINISHED 41 - DOCUMENT_ALREADY_SEALED
      Parameters:
      statusCode - Integer representation of the status. Following is the list of possible values: 0 - COMPLETED 1 - CREATED 2 - CONVERTED_ONLY 3 - SEALED_ONLY 10 - UPLOAD_STARTED 11 - UPLOAD_FAILED 20 - CONVERSION_STARTED 21 - CONVERSION_FAILED 22 - CONVERSION_FINISHED 24 - SUBMISSION_STARTED 25 - SUBMISSION_FAILED 30 - SEAL_STARTED 31 - SEALING_FAILED 32 - SEAL_FINISHED 41 - DOCUMENT_ALREADY_SEALED