Package com.yahoo.documentapi
Class DocumentIdResponse
java.lang.Object
com.yahoo.documentapi.Response
com.yahoo.documentapi.DocumentIdResponse
The asynchronous response to a document remove 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
ConstructorDescriptionDocumentIdResponse
(long requestId) Creates a successful responseDocumentIdResponse
(long requestId, com.yahoo.document.DocumentId documentId) Creates a successful response containing a document idDocumentIdResponse
(long requestId, com.yahoo.document.DocumentId documentId, String textMessage, Response.Outcome outcome) Creates a response containing a textual message and/or a document idDocumentIdResponse
(long requestId, com.yahoo.document.DocumentId documentId, String textMessage, Response.Outcome outcome, com.yahoo.messagebus.Trace trace) Creates a response containing a textual message and/or a document id -
Method Summary
Methods inherited from class com.yahoo.documentapi.Response
getRequestId, getTextMessage, getTrace, isSuccess, outcome
-
Constructor Details
-
DocumentIdResponse
public DocumentIdResponse(long requestId) Creates a successful response -
DocumentIdResponse
public DocumentIdResponse(long requestId, com.yahoo.document.DocumentId documentId) Creates a successful response containing a document id- Parameters:
documentId
- the DocumentId to encapsulate in the Response
-
DocumentIdResponse
public DocumentIdResponse(long requestId, com.yahoo.document.DocumentId documentId, String textMessage, Response.Outcome outcome) Creates a response containing a textual message and/or a document id- Parameters:
documentId
- the DocumentId to encapsulate in the ResponsetextMessage
- the message to encapsulate in the Responseoutcome
- the outcome of the operation
-
DocumentIdResponse
public DocumentIdResponse(long requestId, com.yahoo.document.DocumentId documentId, String textMessage, Response.Outcome outcome, com.yahoo.messagebus.Trace trace) Creates a response containing a textual message and/or a document id- Parameters:
documentId
- the DocumentId to encapsulate in the ResponsetextMessage
- the message to encapsulate in the Responseoutcome
- the outcome of the operation
-
-
Method Details
-
getDocumentId
public com.yahoo.document.DocumentId getDocumentId()Returns the document id of this response, or null if there is none- Returns:
- the DocumentId, or null
-
hashCode
public int hashCode() -
equals
-
toString
-