dxrecord.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_DXRECORD_H
#define DXCPP_BINDINGS_DXRECORD_H

#include "../bindings.h"

namespace dx {


  class DXRecord: public DXDataObject {
   private:
    dx::JSON describe_(const std::string &s)const{return recordDescribe(dxid_,s);}
    void addTypes_(const std::string &s)const{recordAddTypes(dxid_,s);}
    void removeTypes_(const std::string &s)const{recordRemoveTypes(dxid_,s);}
    dx::JSON getDetails_(const std::string &s)const{return recordGetDetails(dxid_,s);}
    void setDetails_(const std::string &s)const{recordSetDetails(dxid_,s);}
    void setVisibility_(const std::string &s)const{recordSetVisibility(dxid_,s);}
    void rename_(const std::string &s)const{recordRename(dxid_,s);}
    void setProperties_(const std::string &s)const{recordSetProperties(dxid_,s);}
    void addTags_(const std::string &s)const{recordAddTags(dxid_,s);}
    void removeTags_(const std::string &s)const{recordRemoveTags(dxid_,s);}
    void close_(const std::string &s)const{recordClose(dxid_,s);}
    dx::JSON listProjects_(const std::string &s)const{return recordListProjects(dxid_,s);}

   public:
    // Record-specific functions

    DXRecord() { }
    
    DXRecord(const char *dxid, const char *proj=NULL) {
      setIDs(std::string(dxid), (proj == NULL) ? config::CURRENT_PROJECT() : std::string(proj));
    }

    DXRecord(const std::string &dxid,
             const std::string &proj=config::CURRENT_PROJECT()) { setIDs(dxid, proj); }

    DXRecord(const dx::JSON &dxlink) { setIDs(dxlink); }

    void create(const dx::JSON &data_obj_fields=dx::JSON(dx::JSON_OBJECT));

    void create(const DXRecord &init_from,
                const dx::JSON &data_obj_fields=dx::JSON(dx::JSON_OBJECT));

    static DXRecord newDXRecord(const dx::JSON &data_obj_fields=
                                dx::JSON(dx::JSON_OBJECT));

    static DXRecord newDXRecord(const DXRecord &init_from,
                                const dx::JSON &data_obj_fields=
                                dx::JSON(dx::JSON_OBJECT));

    DXRecord clone(const std::string &dest_proj_id,
                   const std::string &dest_folder="/") const;
  };
}
#endif