java/src/main/com/google/appengine/api/search/RemoveDocumentsException.java

   1 // Copyright 2011 Google Inc. All rights reserved.
   2 package com.google.appengine.api.search;
   3
   4 import java.util.ArrayList;
   5 import java.util.List;
   6
   7 /**
   8  * Thrown to indicate that a search service failure occurred while deleting
   9  * documents.
  10  *
  11  * @deprecated As of 1.6.5, replaced by {@link RemoveException}.
  12  */
  13 @Deprecated
  14 public class RemoveDocumentsException extends SearchBaseException {
  15   private static final long serialVersionUID = 1877363623092870992L;
  16
  17   private final List<OperationResult> results;
  18
  19   /**
  20    * Constructs an exception when some error occurred in
  21    * the search service whilst processing a remove documents operation.
  22    *
  23    * @param operationResult the error code and message detail associated with
  24    * the failure
  25    */
  26   public RemoveDocumentsException(OperationResult operationResult) {
  27     this(operationResult, new ArrayList<OperationResult>());
  28   }
  29
  30   /**
  31    * Constructs an exception when some error occurred in
  32    * the search service whilst processing a remove documents operation.
  33    *
  34    * @param operationResult the error code and message detail associated with
  35    * the failure
  36    * @param results the list of {@link OperationResult} where each result is
  37    * associated with the id of a document that was requested to be removed
  38    */
  39   public RemoveDocumentsException(OperationResult operationResult,
  40       List<OperationResult> results) {
  41     super(operationResult);
  42     this.results = results;
  43   }
  44
  45   /**
  46    * @return the list of {@link OperationResult} where each result is
  47    * associated with the id of a document that was requested to be removed
  48    */
  49   public List<OperationResult> getResults() {
  50     return results;
  51   }
  52 }