nsmockup/lib/nsobj/file.js

Test your Suitescripts before deploying to NetSuite

'use strict';

/**
 * Return a new instance of nlobjFile used for accessing and manipulating files in the file cabinet.
 *
 * @classDescription Encapsulation of files (media items) in the file cabinet.
 * @return {nlobjFile}
 * @constructor
 *
 * @since 2009.1
 */
exports.nlobjFile = function nlobjFile(name, type, content) {
    this.id = -1;
    this.name = name;
    this.type = type;
    this.content = content || '';
    this.folder = 1;
    this.encoding = 'utf-8';
    this.online = false;
    this.inactive = false;
    this.descr = null;


    /**
     * Return the name of the file.
     * @return {string}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.getName = function () {
        return this.name;
    };

    /**
     * Sets the name of a file.
     * @param {string} name the name of the file
     * @return {void}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.setName = function (name) {
        this.name = name;
    };

    /**
     * return the internal ID of the folder that this file is in.
     * @return {int}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.getFolder = function () {
        return this.folder;
    };

    /**
     * sets the internal ID of the folder that this file is in.
     * @param {int} folder
     * @return {void}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.setFolder = function (folder) {
        this.folder = folder;
    };

    /**
     * sets the character encoding for the file.
     * @param {String} encoding
     * @return {void}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2010.2
     */
    this.setEncoding = function (encoding) {
        this.encoding = encoding;
    };

    /**
     * return true if the file is "Available without Login".
     * @return {boolean}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.isOnline = function () {
        return this.online;
    };

    /**
     * sets the file's "Available without Login" status.
     * @param {boolean} online
     * @return {void}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.setIsOnline = function (online) {
        this.online = !!online;
    };

    /**
     * return true if the file is inactive.
     * @return {boolean}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.isInactive = function () {
        return this.inactive;
    };

    /**
     * sets the file's inactive status.
     * @param {boolean} inactive
     * @return {void}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.setIsInactive = function (inactive) {
        this.inactive = inactive;
    };

    /**
     * return the file description.
     * @return {string}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.getDescription = function () {
        return this.descr;
    };

    /**
     * sets the file's description.
     * @param {string} descr the file description
     * @return {void}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.setDescription = function (descr) {
        this.descr = descr;
    };

    /**
     * Return the id of the file (if stored in the FC).
     * @return {int}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.getId = function () {
        return this.id;
    };

    /**
     * Return the size of the file in bytes.
     * @return {int}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.getSize = function () {
        return this.content.length;
    };

    /**
     * Return the URL of the file (if stored in the FC).
     * @return {string}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.getURL = function () {
        return this.url;
    };

    /**
     * Return the type of the file.
     * @return {string}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.getType = function () {
        return this.type;
    };

    /**
     * Return the value (base64 encoded for binary types) of the file.
     * @return {string}
     *
     * @method
     * @memberOf nlobjFile
     *
     * @since 2009.1
     */
    this.getValue = function () {
        if (typeof this.content === 'string') {
            return this.content;
        } else {
            return new Buffer(this.content).toString('base64');
        }
    };
};