text: /**
   *    Copyright (C) 2013 10gen Inc.
   *
   *    This program is free software: you can redistribute it and/or  modify
   *    it under the terms of the GNU Affero General Public License, version 3,
   *    as published by the Free Software Foundation.
   *
   *    This program is distributed in the hope that it will be useful,
   *    but WITHOUT ANY WARRANTY; without xbeven the implied warranty of
   *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   *    GNU Affero General Public License for more details.
   *
   *    You should have received a copy of the GNU Affero General Public License
   *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
   *
   *    As a special exception, the copyright holders give permission to link the
   *    code of portions of this program with the OpenSSL library under certain
   *    conditions as described in each individual source file and distribute
   *    linked combinations including the program with the OpenSSL library. You
   *    must comply with the GNU Affero General Public License in all respects
   *    for all of the code used other than as permitted herein. If you modify
   *    file(s) with this exception, you may extend this exception to your
   *    version of the file(s), but you are not obligated to do so. If you do not
   *    wish to do so, delete this exception statement from your version. If you
   *    delete this exception statement from all source files in the program,
   *    then also delete it in the license file.
   */
  
  #pragma once
  
  #include <string>
  #include <vector>
  
  #include "mongo/base/string_data.h"
  #include "mongo/db/jsobj.h"
  #include "mongo/db/namespace_string.h"
  #include "mongo/s/write_ops/batched_delete_document.h"
  #include "mongo/s/write_ops/batched_request_metadata.h"
  
  namespace mongo {
  
  /**
   * This class represents the layout and content of a batched delete runCommand,
   * the request side.
   */
  class BatchedDeleteRequest {
      MONGO_DISALLOW_COPYING(BatchedDeleteRequest);
  
  public:
      //
      // schema declarations
      //
  
      // Name used for the batched delete invocation.
      static const std::string BATCHED_DELETE_REQUEST;
  
      // Field names and types in the batched delete command type.
      static const BSONField<std::string> collName;
      static const BSONField<std::vector<BatchedDeleteDocument*>> deletes;
      static const BSONField<BSONObj> writeConcern;
      static const BSONField<bool> ordered;
      static const BSONField<BSONObj> metadata;
  
      //
      // construction / destruction
      //
  
      BatchedDeleteRequest();
      ~BatchedDeleteRequest();
  
      /** Copies all the fields present in 'this' to 'other'. */
      void cloneTo(BatchedDeleteRequest* other) const;
  
      bool isValid(std::string* errMsg) const;
      BSONObj toBSON() const;
      bool parseBSON(StringData dbName, const BSONObj& source, std::string* errMsg);
      void clear();
      std::string toString() const;
  
      //
      // individual field accessors
      //
  
      void setNS(NamespaceString ns);
      const NamespaceString& getNS() const;
  
      void setDeletes(const std::vector<BatchedDeleteDocument*>& deletes);
  
      /**
       * deletes ownership is transferred to here.
       */
      void addToDeletes(BatchedDeleteDocument* deletes);
      void unsetDeletes();
      bool isDeletesSet() const;
      std::size_t sizeDeletes() const;
      const std::vector<BatchedDeleteDocument*>& getDeletes() const;
      const BatchedDeleteDocument* getDeletesAt(std::size_t pos) const;
  
      void setWriteConcern(const BSONObj& writeConcern);
      void unsetWriteConcern();
      bool isWriteConcernSet() const;
      const BSONObj& getWriteConcern() const;
  
      void setOrdered(bool ordered);
      void unsetOrdered();
      bool isOrderedSet() const;
      bool getOrdered() const;
  
      /*
       * metadata ownership will be transferred to this.
       */
      void setMetadata(BatchedRequestMetadata* metadata);
      bool isMetadataSet() const;
      BatchedRequestMetadata* getMetadata() const;
  
      /**
       * These are no-ops since delete never validates documents. They only exist to fulfill the
       * unified API.
       */
      void setShouldBypassValidation(bool newVal) {}
      bool shouldBypassValidation() const {
          return false;
      }
  
  private:
      // Convention: (M)andatory, (O)ptional
  
      // (M)  collection we're deleting from
      NamespaceString _ns;
      bool _isNSSet;
  
      // (M)  array of individual deletes
      std::vector<BatchedDeleteDocument*> _deletes;
      bool _isDeletesSet;
  
      // (O)  to be issued after the batch applied
      BSONObj _writeConcern;
      bool _isWriteConcernSet;
  
      // (O)  whether batch is issued in parallel or not
      bool _ordered;
      bool _isOrderedSet;
  
      // (O)  metadata associated with this request for internal use.
      std::unique_ptr<BatchedRequestMetadata> _metadata;
  };
  
  }  // namespace mongo
  