Search summary support

README.md

@@ -1,3 +1,5 @@
+# This readme has not been updated to reflect changes made by me, to see new features look at network graph/commit history - hayden
+
 # rest_suite
 
 Server-side Javascript library that wraps parts of the Netsuite SuiteScript API (v2010.1).  This

lib/netsuite_toolkit.js

@@ -1,7 +1,8 @@
 /** @namespace NetsuiteToolkit */
-var NetsuiteToolkit              = {};
-NetsuiteToolkit.RecordProcessor  = {};
-NetsuiteToolkit.SublistProcessor = {};
+var NetsuiteToolkit                = {};
+NetsuiteToolkit.RecordProcessor    = {};
+NetsuiteToolkit.SublistProcessor   = {};
+NetsuiteToolkit.SubrecordProcessor = {};
 
 var line_item_match_error = "Unable to find matching line item with the given field.";
 var malformed_data_error  = "Data for processing line items is malformed.";
@@ -90,6 +91,10 @@ NetsuiteToolkit.setFieldValue = function(record, field_name, value) {
   record.setFieldValue(field_name, value);
 }
 
+NetsuiteToolkit.getFieldValue = function(record, field_name) {
+  return record.getFieldValue(field_name);
+}
+
 /**
  * Fetches the line item count for a given NetSuite sublist.
  *
@@ -114,8 +119,8 @@ NetsuiteToolkit.getLineItemCount = function(record, sublist_name) {
  * @memberof NetsuiteToolkit
  * @return {number} The value of the filed on the given sublist at the given index
  */
-NetsuiteToolkit.getLineItemValue = function(record, sublist_name, index, field_name) {
-  return record.getLineItemValue(sublist_name, index, field_name);
+NetsuiteToolkit.getLineItemValue = function(record, sublist_name, field_name, index) {
+  return record.getLineItemValue(sublist_name, field_name, index);
 }
 
 /**
@@ -162,6 +167,35 @@ NetsuiteToolkit.removeLineItem = function(record, sublist_name, index) {
   record.removeLineItem(sublist_name, index);
 }
 
+NetsuiteToolkit.selectNewLineItem = function(record, sublist_name) {
+  record.selectNewLineItem(sublist_name);
+}
+
+NetsuiteToolkit.setCurrentLineItemValue = function(record, item, field, value) {
+  record.setCurrentLineItemValue(item, field, value);
+}
+
+NetsuiteToolkit.commitLineItem = function(record, item) {
+  record.commitLineItem(item);
+}
+
+NetsuiteToolkit.findLineItemValue = function(record, item, field, value) {
+  return record.findLineItemValue(item, field, value);
+}
+
+NetsuiteToolkit.selectLineItem = function(record, item, linenum) {
+  record.selectLineItem(item, linenum);
+}
+
+NetsuiteToolkit.createCurrentLineItemSubrecord = function(record, sublist, subrecord) {
+  return record.createCurrentLineItemSubrecord(sublist, subrecord);
+}
+
+NetsuiteToolkit.editCurrentLineItemSubrecord = function(record, sublist, subrecord) {
+  return record.editCurrentLineItemSubrecord(sublist, subrecord);
+}
+
+
 /**
  * Removes a line item at a given index for a given sublist field.
  *
@@ -305,6 +339,7 @@ NetsuiteToolkit.SublistProcessor = (function() {
     this.create_list  = sublist_data['create'] || [];
     this.update_list  = sublist_data['update'] || [];
     this.excise_list  = sublist_data['excise'] || [];
+    this.bySelect     = sublist_data['bySelect'] || false;
   }
 
   /**
@@ -369,14 +404,39 @@ NetsuiteToolkit.SublistProcessor = (function() {
    * @memberof NetsuiteToolkit.SublistProcessor
    */
   SublistProcessor.prototype.createLineItem = function(creation_request) {
+
+
     index = creation_request['index'];
     data  = creation_request['data'];
-
-    if(!index) {
-      index = NetsuiteToolkit.getLineItemCount(this.record, this.sublist_name);
-    }
-    NetsuiteToolkit.insertLineItem(this.record, this.sublist_name, index);
-    this.updateLineItemFields(index, data);
+    subrecord_request = creation_request['subrecord'];
+
+    if(!this.bySelect){
+        if(!index) {
+          index = NetsuiteToolkit.getLineItemCount(this.record, this.sublist_name);
+        }
+
+        if(this.sublist_name == 'addressbook') {
+          NetsuiteToolkit.selectNewLineItem(this.record, this.sublist_name );
+
+          for(field in data) {
+          value = data[field];
+          NetsuiteToolkit.setCurrentLineItemValue(this.record, this.sublist_name, field, value);
+          }
+
+          if(subrecord_request) {
+          subrecord_processor = new NetsuiteToolkit.SubrecordProcessor(this.record, this.sublist_name, subrecord_request);    
+          subrecord_processor.processCreations();  
+          }
+          NetsuiteToolkit.commitLineItem(this.record, this.sublist_name);
+        }else{//end address book
+          NetsuiteToolkit.insertLineItem(this.record, this.sublist_name, index);
+          this.updateLineItemFields(index, data);
+        }
+     }else{
+          this.record.selectNewLineItem(this.sublist_name)
+          this.updateLineItemFields(index, data);
+          this.record.commitLineItem(this.sublist_name)
+     }
   }
 
   /**
@@ -391,14 +451,21 @@ NetsuiteToolkit.SublistProcessor = (function() {
     index = update_request['index'];
     match = update_request['match'];
     data  = update_request['data'];
-
-    if(!index && !match) {
-      throw NetsuiteToolkit.SublistProcessor.UnableToMatch;
-    } else if(!index) {
-      index = this.matchLineItemByField(match, data);
+    subrecord_request = update_request['subrecord'];
+
+    if(this.sublist == 'addressbook') {
+      if(subrecord_request) {
+        subrecord_processor = new NetsuiteToolkit.SubrecordProcessor(this.record, this.sublist, subrecord_request);    
+        subrecord_processor.processUpdates();  
+      }
+    } else {
+      if(!index && !match) {
+        throw NetsuiteToolkit.SublistProcessor.UnableToMatch;
+      } else if(!index) {
+        index = this.matchLineItemByField(match, data);
+      }
+      this.updateLineItemFields(index, data);
     }
-
-    this.updateLineItemFields(index, data);
   };
 
   /**
@@ -435,7 +502,8 @@ NetsuiteToolkit.SublistProcessor = (function() {
   SublistProcessor.prototype.updateLineItemFields = function(index, line_item_data) {
     for(field in line_item_data) {
       value = line_item_data[field];
-      NetsuiteToolkit.setLineItemValue(this.record, this.sublist_name, field, index, value);
+      if(!this.bySelect)NetsuiteToolkit.setLineItemValue(this.record, this.sublist_name, field, index, value);
+      else this.record.setCurrentLineItemValue(this.sublist_name, field, value);
     }
   }
 
@@ -473,20 +541,60 @@ NetsuiteToolkit.SublistProcessor = (function() {
    */
   SublistProcessor.prototype.compareLineItemValue = function(index, match_field, match_value) {
     netsuite_value = NetsuiteToolkit.getLineItemValue(this.record, this.sublist_name,
-                                                      index, match_field);
+                                                      match_field, index);
     return (netsuite_value == match_value);
   }
 
   return SublistProcessor;
 })();
 
+NetsuiteToolkit.SubrecordProcessor = (function() {
+  function SubrecordProcessor(record, sublist, subrecord_data) {
+    this.record         = record;
+    this.sublist        = sublist;
+    this.subrecord_name = subrecord_data['name'];
+    this.data           = subrecord_data['data'];
+    this.match          = subrecord_data['match'];
+  }
+
+  SubrecordProcessor.prototype.processCreations = function() {
+    var subrecord = NetsuiteToolkit.createCurrentLineItemSubrecord(this.record, this.sublist, this.subrecord_name);
+
+    for(field in this.data) {
+      value = this.data[field];
+      NetsuiteToolkit.setFieldValue(subrecord, field, value);
+    }
+    subrecord.commit();   
+  }
+
+  SubrecordProcessor.prototype.processUpdates = function() {
+    var linenum = NetsuiteToolkit.findLineItemValue(this.record, this.sublist, this.match['field'], this.match['value']);
+
+    if(linenum && linenum > 0) {
+      NetsuiteToolkit.selectLineItem(this.record, this.sublist, linenum);
+      var subrecord = NetsuiteToolkit.editCurrentLineItemSubrecord(this.record, this.sublist, this.subrecord_name);
+
+      for(field in data) {
+        var value = data[field];
+        NetsuiteToolkit.setFieldValue(subrecord, field, value);
+      }
+      subrecord.commit();
+    } else {
+      throw NetsuiteToolkit.SubrecordProcessor.UnableToMatch;
+    }
+  }
+
+  return SubrecordProcessor;
+})();
+
 /**
  * An exception thrown in the event that the sublist data given is malformed.
  * @static
  * @field
  * @memberof NetsuiteToolkit.SublistProcessor
  */
 NetsuiteToolkit.SublistProcessor.MalformedData = new Error(malformed_data_error);
+NetsuiteToolkit.SubrecordProcessor.MalformedData = new Error(malformed_data_error);
 
 /**
  * An exception thrown in the event that a line item cannot be matched
@@ -496,6 +604,7 @@ NetsuiteToolkit.SublistProcessor.MalformedData = new Error(malformed_data_error)
  * @memberof NetsuiteToolkit.SublistProcessor
  */
 NetsuiteToolkit.SublistProcessor.UnableToMatch = new Error(line_item_match_error);
+NetsuiteToolkit.SubrecordProcessor.UnableToMatch = new Error(line_item_match_error);
 
 if(typeof(exports) != 'undefined') {
   exports.NetsuiteToolkit = NetsuiteToolkit;

lib/saved_search.js

@@ -10,10 +10,17 @@
 this.SavedSearch = (function() {
 
   /** @constructor */
-  function SavedSearch(recordType, searchId, lowerBound, batchSize) {
-    this.recordType         = recordType;
+  function SavedSearch(recordType, searchId, lowerBound, batchSize, searchFilters) {
+
+    this.SEARCH_FILTER_NAME_KEY     = 'name';
+    this.SEARCH_FILTER_OPERATOR_KEY = 'operator';
+    this.SEARCH_FILTER_VALUE_KEY    = 'value';
+    this.SEARCH_FILTER_JOIN_KEY     = 'join';
+
+        this.recordType         = recordType;
     this.searchId           = searchId;
     this.lowerBound         = lowerBound;
+    this.lowerBoundFilterIndex = 0;
     this.originalLowerBound = lowerBound;
     this.originalBatchSize  = batchSize;
 
@@ -22,15 +29,38 @@ this.SavedSearch = (function() {
       intBatchSize = intBatchSize + (1000 - (intBatchSize % 1000));
     }
     this.batchSize = intBatchSize;
+
+    this.rawSearchFilters      = searchFilters;
 
     this.searchFilters      = [];
     this.searchColumns      = [];
     this.results            = [];
 
-    this.createSearchFilter();
-    this.createSearchColumn();
+    this.createSearchFilters();
+    if(lowerBound && batchSize)this.generateLowerBoundFilter();
+    if(lowerBound && batchSize)this.createSearchColumn();
   }
 
+
+    /**
+   * Iterates over `rawSearchFilters` calling generating an nlobjSearchFilter
+   * from each
+   *
+   * @method
+   * @memberof Searcher
+   * @return {null}
+   */
+  SavedSearch.prototype.createSearchFilters = function() {
+    for(index in this.rawSearchFilters) {
+      searchFilterData   = this.rawSearchFilters[index];
+      searchFilterObject = this.getSearchFilterObject(searchFilterData);
+
+      this.searchFilters.push(searchFilterObject);
+    }
+    this.lowerBoundFilterIndex = this.searchFilters.length;
+  }
+
+
   /**
    * Generates a new nlobjSearchFilter instance and adds it to the
    * list of search filters
@@ -39,12 +69,34 @@ this.SavedSearch = (function() {
    * @memberof SavedSearch
    * @return {null}
    */
-  SavedSearch.prototype.createSearchFilter = function() {
-    this.searchFilters = []
-    filter = NetsuiteToolkit.searchFilter('internalidnumber', null,
-                                          'greaterthan', this.lowerBound);
-    this.searchFilters.push(filter);
+  SavedSearch.prototype.generateLowerBoundFilter = function() {
+    searchFilterData = {};
+    searchFilterData[this.SEARCH_FILTER_NAME_KEY]     = 'internalidnumber';
+    searchFilterData[this.SEARCH_FILTER_OPERATOR_KEY] = 'greaterthan';
+    searchFilterData[this.SEARCH_FILTER_VALUE_KEY]    = this.lowerBound;
+
+    lowerBoundFilterObject = this.getSearchFilterObject(searchFilterData)
+    this.searchFilters[this.lowerBoundFilterIndex] = lowerBoundFilterObject;
   }
+  /**
+   * Generates an nlobjSearchFilter with the given params
+   *
+   * @method
+   * @param {object} searchFilterData The object representing the search filter params
+   * @memberof Searcher
+   * @return {nlobjSearchFilter} The generated search filter
+   */
+  SavedSearch.prototype.getSearchFilterObject = function(searchFilterData) {
+    name     = searchFilterData[this.SEARCH_FILTER_NAME_KEY];
+    operator = searchFilterData[this.SEARCH_FILTER_OPERATOR_KEY];
+    value    = searchFilterData[this.SEARCH_FILTER_VALUE_KEY];
+    join	 = searchFilterData[this.SEARCH_FILTER_JOIN_KEY];
+    if (typeof join == 'undefined')join = null;
+
+    filter = NetsuiteToolkit.searchFilter(name, join, operator, value);
+    return filter;
+  }
+
 
   /**
    * Generates a new nlobjSearchColumn instance and adds it to the
@@ -134,7 +186,7 @@ this.SavedSearch = (function() {
   SavedSearch.prototype.updateBoundAndFilter = function(resultsBlock) {
     newLowerBound = this.extractLowerBound(resultsBlock);
     this.lowerBound = newLowerBound;
-    this.createSearchFilter();
+    this.generateLowerBoundFilter();
   }
 
   /**
@@ -158,7 +210,35 @@ this.SavedSearch = (function() {
    * @return {null}
    */
   SavedSearch.prototype.appendResults = function(resultsBlock) {
-    this.results = this.results.concat(resultsBlock);
+    var newResultsBlock = [];
+    for ( var i = 0; resultsBlock != null && i < resultsBlock.length; i++ )
+    {
+      	var newResult = {"id":resultsBlock[i].getId(), "recordtype":resultsBlock[i].getRecordType(), "columns":{}};
+      	var result = resultsBlock[i];
+      	var columns = result.getAllColumns();
+      	var columnLen = columns.length;
+
+      	for (x = 0; x < columnLen; x++)
+         {
+           var column = columns[x];
+           var name = column.getName();
+           var label = column.getLabel();
+           var join = column.getJoin();
+           var value = result.getValue(column);
+           var text = result.getText(column);
+           var joinTitle = join + 'Join';
+           var columnTitle = (label ? label : name);
+           if(text && (text !== value))var columnData = {'name':text, 'internalId':value};
+           else columnData = value;           
+           if(join && !label){
+             	if(!(joinTitle in newResult.columns))newResult.columns[joinTitle] = {};
+				newResult.columns[joinTitle][columnTitle] = columnData;
+           }
+           else newResult.columns[columnTitle] = columnData;
+         }
+     	 newResultsBlock.push(newResult);
+    }
+    this.results = this.results.concat(newResultsBlock);
   }
 
   /**
@@ -205,7 +285,7 @@ this.SavedSearch = (function() {
  */
 var savedSearchPostHandler = function(request) {
   var savedSearch = new SavedSearch(request['record_type'], request['search_id'],
-                                    request['lower_bound'], request['batch_size']);
+                                    request['lower_bound'], request['batch_size'],request['search_filters']);
   savedSearch.executeSearch();
   return savedSearch.reply();
 }