Package com.yahoo.documentapi

Class DocumentIdResponse

java.lang.Object
com.yahoo.documentapi.Response
com.yahoo.documentapi.DocumentIdResponse
public class DocumentIdResponse extends Response
The asynchronous response to a document remove operation. This is a value object.
Author:
Einar M R Rosenvinge

  • 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

      @Deprecated(since="7") public DocumentIdResponse(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

    • DocumentIdResponse

      @Deprecated(since="7") public DocumentIdResponse(long requestId, com.yahoo.document.DocumentId documentId, String textMessage, boolean success)
      Deprecated.
      Creates a response containing a textual message and/or a document id
      Parameters:
      documentId - the DocumentId to encapsulate in the Response
      textMessage - the message to encapsulate in the Response
      success - true if the response represents a successful call

    • 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 Response
      textMessage - the message to encapsulate in the Response
      outcome - 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 Response
      textMessage - the message to encapsulate in the Response
      outcome - 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()
      Overrides:
      hashCode in class Response

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Response

    • toString

      public String toString()
      Overrides:
      toString in class Response