Package com.yahoo.documentapi

Class Response

java.lang.Object

com.yahoo.documentapi.Response

Direct Known Subclasses:

DocumentIdResponse, DocumentResponse, DocumentUpdateResponse, RemoveResponse, UpdateResponse

public class Response
extends Object

An asynchronous response from the document api. Subclasses of this provide additional response information for particular operations.

This is a value object.

Author:

bratseth

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Response.Outcome

Constructor Summary

Constructors

Constructor	Description
Response(long requestId)	Creates a successful response containing no information
Response(long requestId, String textMessage)	Creates a successful response containing a textual message
Response(long requestId, String textMessage, boolean success)	Deprecated.
Response(long requestId, String textMessage, Response.Outcome outcome)	Creates a response containing a textual message
Response(long requestId, String textMessage, Response.Outcome outcome, com.yahoo.messagebus.Trace trace)	Creates a response containing a textual message

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
long	getRequestId()
String	getTextMessage()	Returns the text message of this response or null if there is none
com.yahoo.messagebus.Trace	getTrace()	Returns the trace of this operation, or null if there is none.
int	hashCode()
boolean	isSuccess()	Returns whether this response encodes a success or a failure
Response.Outcome	outcome()	Returns the outcome of this operation.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Response

public Response(long requestId)

Creates a successful response containing no information

Response

public Response(long requestId,
 String textMessage)

Creates a successful response containing a textual message

Parameters:

textMessage - the message to encapsulate in the Response

Response

@Deprecated(since="7")
public Response(long requestId,
 String textMessage,
 boolean success)

Deprecated.

Creates a response containing a textual message

Parameters:

textMessage - the message to encapsulate in the Response

success - true if the response represents a successful call

Response

public Response(long requestId,
 String textMessage,
 Response.Outcome outcome)

Creates a response containing a textual message

Parameters:

textMessage - the message to encapsulate in the Response

outcome - the outcome of the operation

Response

public Response(long requestId,
 String textMessage,
 Response.Outcome outcome,
 com.yahoo.messagebus.Trace trace)

Creates a response containing a textual message

Parameters:

textMessage - the message to encapsulate in the Response

outcome - the outcome of the operation

Method Details

getTextMessage

public String getTextMessage()

Returns the text message of this response or null if there is none

Returns:

the message, or null

isSuccess

public boolean isSuccess()

Returns whether this response encodes a success or a failure

Returns:

true if success

outcome

public Response.Outcome outcome()

Returns the outcome of this operation.

getRequestId

public long getRequestId()

getTrace

public com.yahoo.messagebus.Trace getTrace()

Returns the trace of this operation, or null if there is none.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object