src/datasets/Datasets.js

'use strict';

import BaseProvision from '../provision/BaseProvision';
import checkType from '../util/formats/check_types'
/**
 * This is a base object that contains all you can do about Datasets.
 */

export default class Datasets extends BaseProvision {

    /**
     * Constructor
     * @param {InternalOpenGateAPI} Reference to the API object.
     */
    constructor(ogapi) {
        super(ogapi, '/organizations/', undefined, ['name', 'organization', 'columns', 'identifierColumn']);
    }

    _buildURL() {
        let url = 'datasets/provision/organizations/' + this._organization + '/' + this._identifier;

        if (this._onlyPlan) {
            url += '?onlyPlan=true'
        }
        return url;
    }

    /**
     * Set the organization attribute
     * @param {string} organization - required field
     * @return {Datasets}
     */
    withOrganization(organization) {
        checkType._checkStringAndLength(organization, 50, 'organization');
        this._organization = organization;
        return this;
    }

    /**
     * Set the identifier attribute
     * @param {string} identifier - required field
     * @return {Datasets}
     */
    withIdentifier(identifier) {
        checkType._checkString(identifier, 'identifier');
        this._identifier = identifier;
        return this;
    }

    /**
     * Set the name attribute
     * @param {string} name - required field
     * @return {Datasets}
     */
    withName(name) {
        checkType._checkString(name, 'name');
        this._name = name;
        return this;
    }

    /**
     * Set the identifierColumn attribute
     * @param {string} identifierColumn - required field
     * @return {Datasets}
     */
    withIdentifierColumn(identifierColumn) {
        checkType._checkString(identifierColumn, 'identifierColumn');
        this._identifierColumn = identifierColumn;
        return this;
    }

    /**
     * Set the description attribute
     * @param {string} description
     * @return {Datasets}
     */
    withDescription(description) {
        if (description)
            checkType._checkString(description, 'description');
        this._description = description;
        return this;
    }

    /**
     * Set the columns attribute
     * @param {array} columns - required field
     * @return {Datasets}
     */
    withColumns(columns) {
        checkType._checkArray(columns, 'columns');
        this._columns = columns;
        return this;
    }


    _composeElement() {
        this._resource = 'datasets/provision/organizations/' + this._organization;
        let dataset = {
            name: this._name,
            description: this._description,
            type: this._type,
            identifierColumn: this._identifierColumn,
            columns: this._columns
        };
        return dataset;
    }

    _composeUpdateElement() {
        let dataset = {
            name: this._name,
            description: this._description,
            type: this._type,
            identifierColumn: this._identifierColumn,
            columns: this._columns
        };
        return dataset;
    }

    onlyPlan() {
        this._onlyPlan = true;
        return this;
    }

    /**
     * This method invalidates the update option
     * @throws {Allways} Datasets cannot be updated.
     */
    //  update() {
    //     throw new Error("OGAPI_DAATASET_NOT_UPDATED");
    // }
}