Clarify the use of the term "Document" in gdata_wapi_operations.h.

chrome/browser/google_apis/gdata_wapi_operations.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_GOOGLE_APIS_GDATA_WAPI_OPERATIONS_H_
 #define CHROME_BROWSER_GOOGLE_APIS_GDATA_WAPI_OPERATIONS_H_
 
 #include <string>
 #include <vector>
 
@@ skipping 58 matching lines @@
   const GDataWapiUrlGenerator url_generator_;
   const GURL override_url_;
   const int start_changestamp_;
   const std::string search_string_;
   const bool shared_with_me_;
   const std::string directory_resource_id_;
 
   DISALLOW_COPY_AND_ASSIGN(GetDocumentsOperation);
 };
 
-//========================= GetDocumentEntryOperation ==========================
+//========================= GetResourceEntryOperation ==========================
 
-// This class performs the operation for fetching a single document entry.
-class GetDocumentEntryOperation : public GetDataOperation {
+// This class performs the operation for fetching a single resource entry.
+class GetResourceEntryOperation : public GetDataOperation {
  public:
   // |callback| must not be null.
-  GetDocumentEntryOperation(
+  GetResourceEntryOperation(
       OperationRegistry* registry,
       net::URLRequestContextGetter* url_request_context_getter,
       const GDataWapiUrlGenerator& url_generator,
       const std::string& resource_id,
       const GetDataCallback& callback);
-  virtual ~GetDocumentEntryOperation();
+  virtual ~GetResourceEntryOperation();
 
  protected:
   // UrlFetchOperationBase overrides.
   virtual GURL GetURL() const OVERRIDE;
 
  private:
   const GDataWapiUrlGenerator url_generator_;
   // Resource id of the requested entry.
   const std::string resource_id_;
 
-  DISALLOW_COPY_AND_ASSIGN(GetDocumentEntryOperation);
+  DISALLOW_COPY_AND_ASSIGN(GetResourceEntryOperation);
 };
 
 //========================= GetAccountMetadataOperation ========================
 
 // This class performs the operation for fetching account metadata.
 class GetAccountMetadataOperation : public GetDataOperation {
  public:
   // |callback| must not be null.
   GetAccountMetadataOperation(
       OperationRegistry* registry,
@@ skipping 63 matching lines @@
       scoped_ptr<std::string> download_data) OVERRIDE;
 
  private:
   const DownloadActionCallback download_action_callback_;
   const GetContentCallback get_content_callback_;
   const GURL content_url_;
 
   DISALLOW_COPY_AND_ASSIGN(DownloadFileOperation);
 };
 
-//=========================== DeleteDocumentOperation ==========================
+//=========================== DeleteResourceOperation ==========================
 
-// This class performs the operation for deleting a document.
-class DeleteDocumentOperation : public EntryActionOperation {
+// This class performs the operation for deleting a resource.
+//
+// In WAPI, "gd:deleted" means that the resource was put in the trash, and
+// "docs:removed" means its permanently gone. Since what the class does is to
+// put the resource into trash, we have chosen "Delete" in the name, even though
+// we are preferring the term "Remove" in drive/google_api code.
+class DeleteResourceOperation : public EntryActionOperation {
  public:
   // |callback| must not be null.
-  DeleteDocumentOperation(
+  DeleteResourceOperation(
       OperationRegistry* registry,
       net::URLRequestContextGetter* url_request_context_getter,
       const EntryActionCallback& callback,
       const GURL& edit_url);
-  virtual ~DeleteDocumentOperation();
+  virtual ~DeleteResourceOperation();
 
  protected:
   // UrlFetchOperationBase overrides.
   virtual GURL GetURL() const OVERRIDE;
   virtual net::URLFetcher::RequestType GetRequestType() const OVERRIDE;
   virtual std::vector<std::string> GetExtraRequestHeaders() const OVERRIDE;
 
  private:
   const GURL edit_url_;
 
-  DISALLOW_COPY_AND_ASSIGN(DeleteDocumentOperation);
+  DISALLOW_COPY_AND_ASSIGN(DeleteResourceOperation);
 };
 
 //========================== CreateDirectoryOperation ==========================
 
 // This class performs the operation for creating a directory.
 class CreateDirectoryOperation : public GetDataOperation {
  public:
   // A new directory will be created under a directory specified by
   // |parent_content_url|. If this parameter is empty, a new directory will
   // be created in the root directory.
@@ skipping 15 matching lines @@
                               std::string* upload_content) OVERRIDE;
 
  private:
   const GDataWapiUrlGenerator url_generator_;
   const GURL parent_content_url_;
   const FilePath::StringType directory_name_;
 
   DISALLOW_COPY_AND_ASSIGN(CreateDirectoryOperation);
 };
 
-//============================ CopyDocumentOperation ===========================
+//============================ CopyHostedDocumentOperation =====================
 
 // This class performs the operation for making a copy of a hosted document.
 // Note that this function cannot be used to copy regular files, as it's not
 // supported by WAPI.
-class CopyDocumentOperation : public GetDataOperation {
+class CopyHostedDocumentOperation : public GetDataOperation {
  public:
   // |callback| must not be null.
-  CopyDocumentOperation(
+  CopyHostedDocumentOperation(
       OperationRegistry* registry,
       net::URLRequestContextGetter* url_request_context_getter,
       const GDataWapiUrlGenerator& url_generator,
       const GetDataCallback& callback,
       const std::string& resource_id,
       const FilePath::StringType& new_name);
-  virtual ~CopyDocumentOperation();
+  virtual ~CopyHostedDocumentOperation();
 
  protected:
   // UrlFetchOperationBase overrides.
   virtual net::URLFetcher::RequestType GetRequestType() const OVERRIDE;
   virtual GURL GetURL() const OVERRIDE;
   virtual bool GetContentData(std::string* upload_content_type,
                               std::string* upload_content) OVERRIDE;
 
  private:
   const GDataWapiUrlGenerator url_generator_;
   const std::string resource_id_;
   const FilePath::StringType new_name_;
 
-  DISALLOW_COPY_AND_ASSIGN(CopyDocumentOperation);
+  DISALLOW_COPY_AND_ASSIGN(CopyHostedDocumentOperation);
 };
 
 //=========================== RenameResourceOperation ==========================
 
 // This class performs the operation for renaming a document/file/directory.
 class RenameResourceOperation : public EntryActionOperation {
  public:
   // |callback| must not be null.
   RenameResourceOperation(
       OperationRegistry* registry,
@@ skipping 80 matching lines @@
  private:
   const GDataWapiUrlGenerator url_generator_;
   const GURL parent_content_url_;
   const GURL edit_url_;
 
   DISALLOW_COPY_AND_ASSIGN(AddResourceToDirectoryOperation);
 };
 
 //==================== RemoveResourceFromDirectoryOperation ====================
 
-// This class performs the operation for adding a document/file/directory
+// This class performs the operation for removing a document/file/directory
 // from a directory.
 class RemoveResourceFromDirectoryOperation : public EntryActionOperation {
  public:
   // |callback| must not be null.
   RemoveResourceFromDirectoryOperation(
       OperationRegistry* registry,
       net::URLRequestContextGetter* url_request_context_getter,
       const EntryActionCallback& callback,
       const GURL& parent_content_url,
       const std::string& resource_id);
@@ skipping 184 matching lines @@
   const ResumeUploadCallback callback_;
   const ResumeUploadParams params_;
   bool last_chunk_completed_;
 
   DISALLOW_COPY_AND_ASSIGN(ResumeUploadOperation);
 };
 
 }  // namespace google_apis
 
 #endif  // CHROME_BROWSER_GOOGLE_APIS_GDATA_WAPI_OPERATIONS_H_