Package com.yahoo.documentapi

Class DocumentUpdateResponse

java.lang.Object

com.yahoo.documentapi.Response

com.yahoo.documentapi.DocumentUpdateResponse

public class DocumentUpdateResponse
extends Response

The asynchronous response to a document update operation. This is a value object.

Author:

Einar M R Rosenvinge

Nested Class Summary

Nested classes/interfaces inherited from class com.yahoo.documentapi.Response

Response.Outcome

Constructor Summary

Constructors

Constructor	Description
DocumentUpdateResponse(long requestId)	Creates a successful response
DocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate)	Creates a successful response containing a document update
DocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, java.lang.String textMessage, boolean success)	Deprecated.
DocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, java.lang.String textMessage, Response.Outcome outcome)	Creates a response containing a textual message and/or a document update
DocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, java.lang.String textMessage, Response.Outcome outcome, com.yahoo.messagebus.Trace trace)	Creates a response containing a textual message and/or a document update
DocumentUpdateResponse(long requestId, java.lang.String textMessage, boolean success)	Deprecated.
DocumentUpdateResponse(long requestId, java.lang.String textMessage, Response.Outcome outcome)	Creates a response containing a textual message

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
com.yahoo.document.DocumentUpdate	getDocumentUpdate()	Returns the document update of this response or null if there is none
int	hashCode()
java.lang.String	toString()

Methods inherited from class com.yahoo.documentapi.Response

getRequestId, getTextMessage, getTrace, isSuccess, outcome

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentUpdateResponse

public DocumentUpdateResponse(long requestId)

Creates a successful response

DocumentUpdateResponse

public DocumentUpdateResponse(long requestId,
                              com.yahoo.document.DocumentUpdate documentUpdate)

Creates a successful response containing a document update

Parameters:

documentUpdate - the DocumentUpdate to encapsulate in the Response

DocumentUpdateResponse

@Deprecated(since="7")
public DocumentUpdateResponse(long requestId,
                              java.lang.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

DocumentUpdateResponse

public DocumentUpdateResponse(long requestId,
                              java.lang.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 this operation

DocumentUpdateResponse

@Deprecated(since="7")
public DocumentUpdateResponse(long requestId,
                              com.yahoo.document.DocumentUpdate documentUpdate,
                              java.lang.String textMessage,
                              boolean success)

Deprecated.

Creates a response containing a textual message and/or a document update

Parameters:

documentUpdate - the DocumentUpdate to encapsulate in the Response

textMessage - the message to encapsulate in the Response

success - true if the response represents a successful call

DocumentUpdateResponse

public DocumentUpdateResponse(long requestId,
                              com.yahoo.document.DocumentUpdate documentUpdate,
                              java.lang.String textMessage,
                              Response.Outcome outcome)

Creates a response containing a textual message and/or a document update

Parameters:

documentUpdate - the DocumentUpdate to encapsulate in the Response

textMessage - the message to encapsulate in the Response

outcome - the outcome of this operation

DocumentUpdateResponse

public DocumentUpdateResponse(long requestId,
                              com.yahoo.document.DocumentUpdate documentUpdate,
                              java.lang.String textMessage,
                              Response.Outcome outcome,
                              com.yahoo.messagebus.Trace trace)

Creates a response containing a textual message and/or a document update

Parameters:

documentUpdate - the DocumentUpdate to encapsulate in the Response

textMessage - the message to encapsulate in the Response

outcome - the outcome of this operation

Method Detail

getDocumentUpdate

public com.yahoo.document.DocumentUpdate getDocumentUpdate()

Returns the document update of this response or null if there is none

Returns:

the DocumentUpdate, or null

hashCode

public int hashCode()

Overrides:

hashCode in class Response

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Response

toString

public java.lang.String toString()

Overrides:

toString in class Response