com.worklight.wlclient.api

Class WLFailResponse

java.lang.Object

com.worklight.wlclient.api.WLResponse

com.worklight.wlclient.api.WLFailResponse

Direct Known Subclasses:

WLProcedureInvocationFailResponse

public class WLFailResponse
extends WLResponse

This class extends WLResponse and contains the status in WLResponse, error codes, and messages. This class also contains the original response DataObject from the server. Contains the original response data object from the server as well.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HTTP_STATUS
static java.lang.String	JSON_KEY_FAILURES

Constructor Summary

Constructors

Constructor and Description
WLFailResponse(Response httpResponse)
WLFailResponse(WLErrorCode errorCode, java.lang.String errorMsg, WLRequestOptions requestOptions)

Method Summary

Modifier and Type	Method and Description
WLErrorCode	getErrorCode() Deprecated. As of MobileFirst v8.0, replaced by getErrorStatusCode method. The WLErrorCode section contains a description of the possible errors.
java.lang.String	getErrorMsg() This method returns an error message that is for the developer, and not necessarily suitable for the user.
java.lang.String	getErrorStatusCode()
java.lang.String	toString()

Methods inherited from class com.worklight.wlclient.api.WLResponse

getFirstHeader, getHeader, getHeaders, getInvocationContext, getOptions, getResponseBytes, getResponseJSON, getResponseText, getStatus, getStatusText, setOptions, setResponseText, setStatusText

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

JSON_KEY_FAILURES

public static final java.lang.String JSON_KEY_FAILURES

See Also:

Constant Field Values

HTTP_STATUS

public static final int HTTP_STATUS

See Also:

Constant Field Values

Constructor Detail

WLFailResponse

public WLFailResponse(Response httpResponse)

WLFailResponse

public WLFailResponse(WLErrorCode errorCode,
                      java.lang.String errorMsg,
                      WLRequestOptions requestOptions)

Method Detail

getErrorStatusCode

public java.lang.String getErrorStatusCode()

Returns:

error code

getErrorCode

public WLErrorCode getErrorCode()

Deprecated. As of MobileFirst v8.0, replaced by getErrorStatusCode method.
The WLErrorCode section contains a description of the possible errors.

Returns:

possible errors define in WLErrorCode

getErrorMsg

public java.lang.String getErrorMsg()

This method returns an error message that is for the developer, and not necessarily suitable for the user.

Returns:

A developer oriented errorCode message(no necessarily suitable to display for the user).

toString

public java.lang.String toString()

Overrides:

toString in class WLResponse