Package com.yahoo.documentapi
Class DocumentUpdateResponse
java.lang.Object
com.yahoo.documentapi.Response
com.yahoo.documentapi.DocumentUpdateResponse
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
ConstructorDescriptionDocumentUpdateResponse
(long requestId) Creates a successful responseDocumentUpdateResponse
(long requestId, com.yahoo.document.DocumentUpdate documentUpdate) Creates a successful response containing a document updateDocumentUpdateResponse
(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, String textMessage, Response.Outcome outcome) Creates a response containing a textual message and/or a document updateDocumentUpdateResponse
(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, String textMessage, Response.Outcome outcome, com.yahoo.messagebus.Trace trace) Creates a response containing a textual message and/or a document updateDocumentUpdateResponse
(long requestId, String textMessage, Response.Outcome outcome) Creates a response containing a textual message -
Method Summary
Methods inherited from class com.yahoo.documentapi.Response
getRequestId, getTextMessage, getTrace, isSuccess, outcome
-
Constructor Details
-
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
Creates a response containing a textual message- Parameters:
textMessage
- the message to encapsulate in the Responseoutcome
- the outcome of this operation
-
DocumentUpdateResponse
public DocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, 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 ResponsetextMessage
- the message to encapsulate in the Responseoutcome
- the outcome of this operation
-
DocumentUpdateResponse
public DocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, 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 ResponsetextMessage
- the message to encapsulate in the Responseoutcome
- the outcome of this operation
-
-
Method Details
-
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() -
equals
-
toString
-