Interface CHVerificationResult<T>
- Type Parameters:
T- The expected data type of the result of the operation
public interface CHVerificationResult<T>
The synchronised result object that will be returned by all operations in
CHVerificationManager. This
generic result object will contain:
- A flag to easily determine if the operation is successful or not. See
isSuccessful() - The result object - This will contain the result of the operation, with
the expected data type, should the operation be successful. See
getResult() - The error message - This will contain a descriptive message detailing the
reasons for the failed operation. This will be null if the operation is
successful. See
getErrorMessage()
-
Method Summary
Modifier and TypeMethodDescriptionReturns a descriptive error message if the operation failed.Returns the result object of the operation.booleanDefines if the operation executed successfully or not.
-
Method Details
-
isSuccessful
boolean isSuccessful()Defines if the operation executed successfully or not.- Returns:
- Returns true if the operation executed successfully. Otherwise, it returns false.
-
getResult
T getResult()Returns the result object of the operation.- Returns:
- The result of the operation.
-
getErrorMessage
String getErrorMessage()Returns a descriptive error message if the operation failed. If the operation is successful, this will return null.- Returns:
- String representation of the error message describing why the operation failed. It returns null if the operation is successful.
-