io.digified.digified_library.api.result

Class DigifiedResult

java.lang.Object

io.digified.digified_library.api.result.DigifiedResult

Direct Known Subclasses:

FaceMatchResult, IdExtractionResult, InitializationResult

public abstract class DigifiedResult
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DigifiedResult(String message, String nextProcess, Integer overallStatus, Integer result, Boolean shouldTerminate, String error, ArrayList<String> errorCode) Constructor for the DigifiedResult

Method Summary

Modifier and Type	Method and Description
String	getError() Getter method for error: the error message
ArrayList<String>	getErrorCode() Getter method for errorCode: the error code
String	getMessage() Getter method for message: represents the recommended action for user
String	getNextProcess() Getter method for nextProcess: represents the next operation
Integer	getOverallStatus() Getter method for overallStatus: Enumeration representing overall status of the session: (FAILED: 0, VERIFIED: 1, IN_PROGRESS: 2, PENDING: 3)
Integer	getResult() Getter method for result: indicating the session status: (SUCCESS: 0, HAS_ERRORS: -1, HAS_WARNINGS: 1)
Boolean	getShouldTerminate() Getter method for shouldTerminate: False if there will be a next op-state / try, True otherwise.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DigifiedResult

public DigifiedResult(String message,
                      String nextProcess,
                      Integer overallStatus,
                      Integer result,
                      Boolean shouldTerminate,
                      String error,
                      ArrayList<String> errorCode)

Constructor for the DigifiedResult

Parameters:

message - "msg" in the API response, represents the recommended action for user

nextProcess - "next" in the API response, represents the next operation

overallStatus - "overall_status" in the API response, Enumeration representing overall status of the session: (FAILED: 0, VERIFIED: 1, IN_PROGRESS: 2, PENDING: 3)

result - "result" in the API response, indicating the session status: (SUCCESS: 0, HAS_ERRORS: -1, HAS_WARNINGS: 1)

shouldTerminate - "should_terminate" in the API response, False if there will be a next op-state / try, True otherwise

error - "Error" in the API response, the error message

errorCode - "code" in the API response, the error code

Method Detail

getMessage

public String getMessage()

Getter method for message: represents the recommended action for user

Returns:

"msg" in the API response

getNextProcess

public String getNextProcess()

Getter method for nextProcess: represents the next operation

Returns:

"next" in the API response

getOverallStatus

public Integer getOverallStatus()

Getter method for overallStatus: Enumeration representing overall status of the session: (FAILED: 0, VERIFIED: 1, IN_PROGRESS: 2, PENDING: 3)

Returns:

"overall_status" in the API response

getResult

public Integer getResult()

Getter method for result: indicating the session status: (SUCCESS: 0, HAS_ERRORS: -1, HAS_WARNINGS: 1)

Returns:

"result" in the API response

getShouldTerminate

public Boolean getShouldTerminate()

Getter method for shouldTerminate: False if there will be a next op-state / try, True otherwise.

Returns:

"should_terminate" in the API response

getError

public String getError()

Getter method for error: the error message

Returns:

"Error" in the API response

getErrorCode

public ArrayList<String> getErrorCode()

Getter method for errorCode: the error code

Returns:

"code" in the API response