com.scvngr.levelup.core.net

Class LevelUpResponse

java.lang.Object

com.scvngr.levelup.core.net.AbstractResponse<String>

com.scvngr.levelup.core.net.BufferedResponse

com.scvngr.levelup.core.net.LevelUpResponse

All Implemented Interfaces:

Parcelable

@ThreadSafe
 @Immutable
 @LevelUpApi(contract=PUBLIC)
public final class LevelUpResponse
extends BufferedResponse
implements Parcelable

Class to encompass a response from the LevelUp Web Service.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<LevelUpResponse>	CREATOR Creator for parceling.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
LevelUpResponse(LevelUpStatus status, LevelUpResponse originalResponse)
LevelUpResponse(Parcel in) Constructor for parceling.
LevelUpResponse(String data, LevelUpStatus status)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Exception	getError() Get the error that occurred during the sending of the request OR during the reading of the response.
Error	getServerError(ErrorObject object, ErrorCode code) Get a specific Error from the LevelUpResponse which contains specific values for Error.getObject() and Error.getCode().
List<Error>	getServerErrors()
LevelUpStatus	getStatus()
int	hashCode()
boolean	hasServerErrors()
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class com.scvngr.levelup.core.net.BufferedResponse

describeContents, getData

Methods inherited from class com.scvngr.levelup.core.net.AbstractResponse

getHttpHeader, getHttpHeaders, getHttpStatusCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface android.os.Parcelable

describeContents

Field Detail

CREATOR

public static final Parcelable.Creator<LevelUpResponse> CREATOR

Creator for parceling.

Constructor Detail

LevelUpResponse

public LevelUpResponse(String data,
                       LevelUpStatus status)

Parameters:

data - the string data (typically JSON) from the response from the server.

status - the status of the response. See LevelUpStatus.

LevelUpResponse

public LevelUpResponse(LevelUpStatus status,
                       LevelUpResponse originalResponse)

Parameters:

status - the status of the response. See LevelUpStatus.

originalResponse - the original response the server gave

LevelUpResponse

public LevelUpResponse(Parcel in)

Constructor for parceling.

Parameters:

in - the parcel to read from.

Method Detail

getStatus

public LevelUpStatus getStatus()

Returns:

the LevelUpStatus for this LevelUpResponse.

getServerErrors

public List<Error> getServerErrors()

Returns:

A list of Errors on this server response. Will attempt to parse the Errors from the BufferedResponse.getData() if the errors are not already populated.

hasServerErrors

public boolean hasServerErrors()

Returns:

True if there are any server errors that was parsed on this response.

getServerError

public Error getServerError(ErrorObject object,
                            ErrorCode code)

Get a specific Error from the LevelUpResponse which contains specific values for Error.getObject() and Error.getCode().

Parameters:

object - the ErrorObject of the desired error. This object is scoped to the context of the web service.

code - the ErrorCode of the desired error.

Returns:

the Error or null if the error is not found.

getError

public Exception getError()

Description copied from class: BufferedResponse

Get the error that occurred during the sending of the request OR during the reading of the response.

Overrides:

getError in class BufferedResponse

Returns:

the error that occurred.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class BufferedResponse

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

Overrides:

writeToParcel in class BufferedResponse