com.zendrive.sdk

Class ZendriveOperationResult

java.lang.Object

com.zendrive.sdk.ZendriveOperationResult

public class ZendriveOperationResult
extends java.lang.Object

A result of an operation performed on the Zendrive SDK. This indicates whether the operation was a success or a failure. In the case of failure, a error code and error message are provided.

Method Summary

Modifier and Type	Method and Description
static ZendriveOperationResult	createError(ZendriveErrorCode errorCode, java.lang.String errorMessage) Create a result object for a failed operation.
static ZendriveOperationResult	createSuccess() Create a result object for a successful operation.
ZendriveErrorCode	getErrorCode() Get the error code for the operation if the operation failed.
java.lang.String	getErrorMessage() Get the error message for the operation if this is the result of a failed operation.
boolean	isSuccess() Is the operation successful?

Methods inherited from class java.lang.Object

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

Method Detail

isSuccess

public boolean isSuccess()

Is the operation successful?

Returns:

True if the operation is successful. False otherwise.

getErrorCode

public ZendriveErrorCode getErrorCode()

Get the error code for the operation if the operation failed. If the operation was successful, then null is returned

getErrorMessage

public java.lang.String getErrorMessage()

Get the error message for the operation if this is the result of a failed operation. If this is the result of a successful operation, then null is returned. Note that this message should not be shown to users - as it is neither user friendly nor localized. This message is intended for use by developers who integrate the Zendrive SDK. Use the error code from getErrorCode() to surface appropriate messages to users of your app if necessary.

createError

public static ZendriveOperationResult createError(ZendriveErrorCode errorCode,
                                                  java.lang.String errorMessage)

Create a result object for a failed operation.

Parameters:

errorCode - The error code for the failure.

errorMessage - Detailed message for the failure.

createSuccess

public static ZendriveOperationResult createSuccess()

Create a result object for a successful operation.