dxproject.h

Go to the documentation of this file.

// Copyright (C) 2013-2016 DNAnexus, Inc.
//
// This file is part of dx-toolkit (DNAnexus platform client libraries).
//
//   Licensed under the Apache License, Version 2.0 (the "License"); you may
//   not use this file except in compliance with the License. You may obtain a
//   copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
//   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
//   License for the specific language governing permissions and limitations
//   under the License.

#ifndef DXCPP_BINDINGS_DXPROJECT_H
#define DXCPP_BINDINGS_DXPROJECT_H

#include "../bindings.h"

namespace dx {


  class DXContainer {
   private:
    std::string dxid_;

   public:

    DXContainer(const std::string &dxid=config::CURRENT_PROJECT()) : dxid_(dxid) { }

    void setID(const std::string &dxid) { dxid_ = dxid; }

    std::string getID() const { return dxid_; }

    operator std::string() { return dxid_;}

    // TODO: add wiki link for /class-xxx/describe
    dx::JSON describe(bool folders=false) const;

    void move(const dx::JSON &objects,
              const dx::JSON &folders,
              const std::string &dest_folder) const;

    void clone(const dx::JSON &objects,
               const dx::JSON &folders,
               const std::string &dest_container,
               const std::string &dest_folder="/") const;

    // Folder specific

    void newFolder(const std::string &folder, bool parents=false) const;

    dx::JSON listFolder(const std::string &folder="/") const;

    void moveFolder(const std::string &folder,
                    const std::string &dest_folder) const;

    void removeFolder(const std::string &folder, const bool recurse=false) const;

    // Objects-specific

    void moveObjects(const dx::JSON &objects,
                     const std::string &dest_folder) const {
      move(objects, dx::JSON(dx::JSON_ARRAY), dest_folder);
    }

    void removeObjects(const dx::JSON &objects) const;

    void cloneFolder(const std::string &folder,
                     const std::string &dest_container,
                     const std::string &dest_folder) const {
      clone(dx::JSON(dx::JSON_ARRAY), dx::JSON::parse("[\"" + folder + "\"]"), dest_container, dest_folder);
    }

    void cloneObjects(const dx::JSON &objects,
                      const std::string &dest_container,
                      const std::string &dest_folder) const {
      clone(objects, dx::JSON(dx::JSON_ARRAY), dest_container, dest_folder);
    }
  };



  class DXProject : public DXContainer {
   public:

    DXProject(const std::string &dxid=config::CURRENT_PROJECT()) : DXContainer(dxid) { }

    void update(const dx::JSON &to_update) const;

    void destroy() const;

    void invite(const std::string &invitee, const std::string &level) const;

    // TODO: link to wiki docs
    void decreasePerms(const std::string &member, const std::string &level) const;
  };
}
#endif