From 3d4d01dafbd42fb22db661127f8a732a512c83a8 Mon Sep 17 00:00:00 2001 From: James Christie Date: Fri, 3 May 2013 13:44:24 -0500 Subject: [PATCH] Refactor, document and test: -Upserter -UpsertRequest -NetsuiteToolkit.RecordProcessor -NetsuiteToolkit.SublistProcessor --- .gitignore | 1 - README.md | 2 + doc/Initializer.html | 389 + doc/LoadRequest.html | 582 + doc/Loader.html | 557 + doc/NetsuiteToolkit.RecordProcessor.html | 261 + doc/NetsuiteToolkit.SublistProcessor.html | 1319 + doc/NetsuiteToolkit.html | 2034 ++ doc/UpsertRequest.html | 638 + doc/Upserter.html | 306 + doc/global.html | 210 + doc/index.html | 90 + doc/initialize.js.html | 99 + doc/load.js.html | 211 + doc/netsuite/README.md | 1 + doc/netsuite/global.html | 20418 ++++++++++++++++ doc/netsuite/index.html | 66 + doc/netsuite/nlapihandler_stubs.js | 4890 ++++ doc/netsuite/nlapihandler_stubs.js.html | 4939 ++++ doc/netsuite/nlobjAssistant.html | 3955 +++ doc/netsuite/nlobjAssistantStep.html | 1416 ++ doc/netsuite/nlobjButton.html | 438 + doc/netsuite/nlobjColumn.html | 606 + doc/netsuite/nlobjConfiguration.html | 1640 ++ doc/netsuite/nlobjContext.html | 3069 +++ doc/netsuite/nlobjError.html | 683 + doc/netsuite/nlobjField.html | 2724 +++ doc/netsuite/nlobjFieldGroup.html | 745 + doc/netsuite/nlobjFile.html | 1834 ++ doc/netsuite/nlobjForm.html | 3627 +++ doc/netsuite/nlobjList.html | 1504 ++ doc/netsuite/nlobjPortlet.html | 1624 ++ doc/netsuite/nlobjRecord.html | 5747 +++++ doc/netsuite/nlobjRequest.html | 1533 ++ doc/netsuite/nlobjResponse.html | 1768 ++ doc/netsuite/nlobjSearchColumn.html | 828 + doc/netsuite/nlobjSearchFilter.html | 571 + doc/netsuite/nlobjSearchResult.html | 1047 + doc/netsuite/nlobjSelectOption.html | 342 + doc/netsuite/nlobjServerResponse.html | 868 + doc/netsuite/nlobjSubList.html | 1816 ++ doc/netsuite/nlobjTab.html | 435 + .../scripts/prettify/Apache-License-2.0.txt | 202 + doc/netsuite/scripts/prettify/lang-css.js | 2 + doc/netsuite/scripts/prettify/prettify.js | 28 + doc/netsuite/styles/jsdoc-default.css | 283 + doc/netsuite/styles/prettify-jsdoc.css | 111 + doc/netsuite/styles/prettify-tomorrow.css | 132 + doc/netsuite_toolkit.js.html | 464 + doc/scripts/prettify/Apache-License-2.0.txt | 202 + doc/scripts/prettify/lang-css.js | 2 + doc/scripts/prettify/prettify.js | 28 + doc/styles/jsdoc-default.css | 283 + doc/styles/prettify-jsdoc.css | 111 + doc/styles/prettify-tomorrow.css | 132 + doc/upsert.js.html | 172 + jspec | 3 +- lib/load.js | 1 + lib/netsuite_toolkit.js | 252 +- lib/upsert.js | 132 +- spec/load.spec.js | 4 +- spec/netsuite_toolkit.spec.js | 533 + spec/spec_helper.js | 1 + spec/upsert.spec.js | 298 +- 64 files changed, 79189 insertions(+), 20 deletions(-) create mode 100644 doc/Initializer.html create mode 100644 doc/LoadRequest.html create mode 100644 doc/Loader.html create mode 100644 doc/NetsuiteToolkit.RecordProcessor.html create mode 100644 doc/NetsuiteToolkit.SublistProcessor.html create mode 100644 doc/NetsuiteToolkit.html create mode 100644 doc/UpsertRequest.html create mode 100644 doc/Upserter.html create mode 100644 doc/global.html create mode 100644 doc/index.html create mode 100644 doc/initialize.js.html create mode 100644 doc/load.js.html create mode 100644 doc/netsuite/README.md create mode 100644 doc/netsuite/global.html create mode 100644 doc/netsuite/index.html create mode 100644 doc/netsuite/nlapihandler_stubs.js create mode 100644 doc/netsuite/nlapihandler_stubs.js.html create mode 100644 doc/netsuite/nlobjAssistant.html create mode 100644 doc/netsuite/nlobjAssistantStep.html create mode 100644 doc/netsuite/nlobjButton.html create mode 100644 doc/netsuite/nlobjColumn.html create mode 100644 doc/netsuite/nlobjConfiguration.html create mode 100644 doc/netsuite/nlobjContext.html create mode 100644 doc/netsuite/nlobjError.html create mode 100644 doc/netsuite/nlobjField.html create mode 100644 doc/netsuite/nlobjFieldGroup.html create mode 100644 doc/netsuite/nlobjFile.html create mode 100644 doc/netsuite/nlobjForm.html create mode 100644 doc/netsuite/nlobjList.html create mode 100644 doc/netsuite/nlobjPortlet.html create mode 100644 doc/netsuite/nlobjRecord.html create mode 100644 doc/netsuite/nlobjRequest.html create mode 100644 doc/netsuite/nlobjResponse.html create mode 100644 doc/netsuite/nlobjSearchColumn.html create mode 100644 doc/netsuite/nlobjSearchFilter.html create mode 100644 doc/netsuite/nlobjSearchResult.html create mode 100644 doc/netsuite/nlobjSelectOption.html create mode 100644 doc/netsuite/nlobjServerResponse.html create mode 100644 doc/netsuite/nlobjSubList.html create mode 100644 doc/netsuite/nlobjTab.html create mode 100644 doc/netsuite/scripts/prettify/Apache-License-2.0.txt create mode 100644 doc/netsuite/scripts/prettify/lang-css.js create mode 100644 doc/netsuite/scripts/prettify/prettify.js create mode 100644 doc/netsuite/styles/jsdoc-default.css create mode 100644 doc/netsuite/styles/prettify-jsdoc.css create mode 100644 doc/netsuite/styles/prettify-tomorrow.css create mode 100644 doc/netsuite_toolkit.js.html create mode 100644 doc/scripts/prettify/Apache-License-2.0.txt create mode 100644 doc/scripts/prettify/lang-css.js create mode 100644 doc/scripts/prettify/prettify.js create mode 100644 doc/styles/jsdoc-default.css create mode 100644 doc/styles/prettify-jsdoc.css create mode 100644 doc/styles/prettify-tomorrow.css create mode 100644 doc/upsert.js.html diff --git a/.gitignore b/.gitignore index c67b8cd..4720e8f 100644 --- a/.gitignore +++ b/.gitignore @@ -19,5 +19,4 @@ db/*.sqlite3 log/*.log tags tmp -doc/ npm-debug.log diff --git a/README.md b/README.md index 336b6ee..b0c5a0a 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ note - every object within the scrips are private - every endpoint is a post - actions are taken based on the request body of the post + - netsuite documentation is provided in doc/netsuite/index.html + - project documentation is provided at doc/index.html data-struct reference --------------------- diff --git a/doc/Initializer.html b/doc/Initializer.html new file mode 100644 index 0000000..a2e5483 --- /dev/null +++ b/doc/Initializer.html @@ -0,0 +1,389 @@ + + + + + JSDoc: Class: Initializer + + + + + + + + + + +
+ +

Class: Initializer

+ + + + + +
+ +
+

+ Initializer +

+ +
+ +
+
+ + + + +
+

new Initializer(request) → {Initializer}

+ + +
+
+ + +
+ Initializer Class +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
request + + +object + + + + The body of the HTTP Post request from the client
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ A new instance of Initializer +
+ + + +
+
+ Type +
+
+ +Initializer + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

generateReply() → {object}

+ + +
+
+ + +
+ Return a formatted reply object generate by NetsuiteToolkit +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ The object containing the formatted reply data +
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + +
+ + + +
+

initializeRecord() → {null}

+ + +
+
+ + +
+ Request the NetsuiteToolkit to return a new, blank record. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/LoadRequest.html b/doc/LoadRequest.html new file mode 100644 index 0000000..c0860d6 --- /dev/null +++ b/doc/LoadRequest.html @@ -0,0 +1,582 @@ + + + + + JSDoc: Class: LoadRequest + + + + + + + + + + +
+ +

Class: LoadRequest

+ + + + + +
+ +
+

+ LoadRequest +

+ +
+ +
+
+ + + + +
+

new LoadRequest(record_type, internalid) → {LoadRequest}

+ + +
+
+ + +
+ LoadRequest Class +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record_type + + +string + + + + the String representing a NetSuite record type
internalid + + +string + + + + the String representing a NetSuite internal id
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ A new instance of LoadRequest +
+ + + +
+
+ Type +
+
+ +LoadRequest + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

execute() → {null}

+ + +
+
+ + +
+ Load a record for a LoadRequest and generate a reply for it. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

generateParams() → {object}

+ + +
+
+ + +
+ Set parameters for a LoadRequest. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ The parameter object +
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + +
+ + + +
+

generateReply() → {object}

+ + +
+
+ + +
+ Generate a LoadRequest reply for the requestor. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ A formatted reply object from NetsuiteToolkit +
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + +
+ + + +
+

loadRecord() → {null}

+ + +
+
+ + +
+ Load a record for a LoadRequest and catch any exceptions. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/Loader.html b/doc/Loader.html new file mode 100644 index 0000000..d4927fc --- /dev/null +++ b/doc/Loader.html @@ -0,0 +1,557 @@ + + + + + JSDoc: Class: Loader + + + + + + + + + + +
+ +

Class: Loader

+ + + + + +
+ +
+

+ Loader +

+ +
+ +
+
+ + + + +
+

new Loader(request) → {Loader}

+ + +
+
+ + +
+ Loader Class +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
request + + +object + + + + The body of the HTTP Post request from the client
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ A new instance of Loader +
+ + + +
+
+ Type +
+
+ +Loader + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

accumulateResult() → {null}

+ + +
+
+ + +
+ Push a result onto the result_list. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

executeLoadRequest() → {null}

+ + +
+
+ + +
+ Instantiate a new LoadRequest given load parameters and accumulate its result +on result_list. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

generateReply() → {object}

+ + +
+
+ + +
+ Generate and return Loader reply for the requestor. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ A formatted reply object from NetsuiteToolkit +
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + +
+ + + +
+

loadRecords() → {null}

+ + +
+
+ + +
+ Iterate through the supplied parameters and load their related +records from NetSuite. Populate result_list or exception accordingly. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/NetsuiteToolkit.RecordProcessor.html b/doc/NetsuiteToolkit.RecordProcessor.html new file mode 100644 index 0000000..04d2b12 --- /dev/null +++ b/doc/NetsuiteToolkit.RecordProcessor.html @@ -0,0 +1,261 @@ + + + + + JSDoc: Namespace: RecordProcessor + + + + + + + + + + +
+ +

Namespace: RecordProcessor

+ + + + + +
+ +
+

+ NetsuiteToolkit. + + RecordProcessor +

+ +
+ +
+
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

<static> updateLiterals(record, fieldData)

+ + +
+
+ + +
+ Update literal fields on a given record with the given fieldData. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record + + +nlobjRecord + + + + The NetSuite record object
fieldData + + +object + + + + Data for literal fields
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/NetsuiteToolkit.SublistProcessor.html b/doc/NetsuiteToolkit.SublistProcessor.html new file mode 100644 index 0000000..4335a41 --- /dev/null +++ b/doc/NetsuiteToolkit.SublistProcessor.html @@ -0,0 +1,1319 @@ + + + + + JSDoc: Namespace: SublistProcessor + + + + + + + + + + +
+ +

Namespace: SublistProcessor

+ + + + + +
+ +
+

+ NetsuiteToolkit. + + SublistProcessor +

+ +
+ +
+
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + +

Members

+ +
+ +
+

<static> MalformedData

+ + +
+
+ +
+ An exception thrown in the event that the sublist data given is malformed. +
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
+ + + +
+

<static> UnableToMatch

+ + +
+
+ +
+ An exception thrown in the event that a line item cannot be matched +to a given field. +
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+

<static> SublistProcessor#compareLineItemValue(index, match_field, match_value) → {Boolean}

+ + +
+
+ + +
+ Compares the value of a given field at a given line item index with the +given value +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
index + + +Number + + + + The Number representing the index position of the line item
match_field + + +String + + + + The String representing the internalid of the line item field
match_value + + +String + + + + The String representing the value to be compared against
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ The Boolean representing the successful match +
+ + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + +
+ + + +
+

<static> SublistProcessor#createLineItem(creation_request)

+ + +
+
+ + +
+ Creates and alters the fields of a new line item using the +given params +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
creation_request + + +object + + + + The Object that hold a single creation + request for a line item
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

<static> SublistProcessor#exciseLineItem(excise_request)

+ + +
+
+ + +
+ Removes a line item using the given params +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
excise_request + + +object + + + + The Object that hold a single excise + request for a line item
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

<static> SublistProcessor#execute()

+ + +
+
+ + +
+ Procedural function to execute all sublist operations on the given +record and sublist +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

<static> SublistProcessor#matchLineItemByField(match_field, data) → {Number}

+ + +
+
+ + +
+ Locates the index of a line item matching the given field data, returns +the first match encountered. An exception is raised if no match is found +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
match_field + + +String + + + + The String representing the internalid of a line item + field
data + + +object + + + + The Object representing the line item field and value + data
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ The Number representing the index of the mateched line item +
+ + + +
+
+ Type +
+
+ +Number + + +
+
+ + + + +
+ + + +
+

<static> SublistProcessor#processCreations()

+ + +
+
+ + +
+ Iterate over list of creation requests and execute them +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

<static> SublistProcessor#processExcisions()

+ + +
+
+ + +
+ Iterate over list of excision requests and execute them +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

<static> SublistProcessor#processUpdates()

+ + +
+
+ + +
+ Iterate over list of update requests and execute them +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

<static> SublistProcessor#updateLineItem(update_request)

+ + +
+
+ + +
+ Alters the fields of a line item using the given params +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
update_request + + +object + + + + The Object that hold a single update + request for a line item
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

<static> SublistProcessor#updateLineItemFields(index, line_item_data)

+ + +
+
+ + +
+ Updates all declared fields of a line item at the given index +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
index + + +Number + + + + The Number representing the index position of + a line item
line_item_data + + +object + + + + The Object representing the fields and values + for a line item alteration
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/NetsuiteToolkit.html b/doc/NetsuiteToolkit.html new file mode 100644 index 0000000..fef8d61 --- /dev/null +++ b/doc/NetsuiteToolkit.html @@ -0,0 +1,2034 @@ + + + + + JSDoc: Namespace: NetsuiteToolkit + + + + + + + + + + +
+ +

Namespace: NetsuiteToolkit

+ + + + + +
+ +
+

+ NetsuiteToolkit +

+ +
+ +
+
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + +

Classes

+ +
+
SublistProcessor
+
+
+ + + +

Namespaces

+ +
+
RecordProcessor
+
+ +
SublistProcessor
+
+
+ + + + + +

Methods

+ +
+ +
+

<static> formatException(exception) → {object}

+ + +
+
+ + +
+ Returns a formatted reply object based off of a given exception. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
exception + + +error + + + + The Error object of the given exception
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ The formatted reply object generated from the exception +
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + +
+ + + +
+

<static> formatReply(params, result, exception) → {object}

+ + +
+
+ + +
+ Returns a formatted reply object using a given set of params, result and possible exception +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
params + + +object + + + + The object holding the params of a request
result + + +object + + + + The object containing the result of the request
exception + + +error + + + + The error object of a raised exception
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ The formatted reply object +
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + +
+ + + +
+

<static> getLineItemCount(record, sublist_name) → {number}

+ + +
+
+ + +
+ Fetches the line item count for a given NetSuite sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record + + +nlobjRecord + + + + The NetSuite record object
sublist_name + + +string + + + + The String representing the NetSuite sublist
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ The line item count for the sublist. +
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + +
+ + + +
+

<static> getLineItemValue(record, sublist_name, index, field_name) → {number}

+ + +
+
+ + +
+ Fetched the value of a line item in a given sublist for a given field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record + + +nlobjRecord + + + + The NetSuite record object
sublist_name + + +string + + + + The String representing the NetSuite sublist
index + + +number + + + + The Number of the sublist index
field_name + + +string + + + + The string representing the name of the field
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ The value of the filed on the given sublist at the given index +
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + +
+ + + +
+

<static> initializeRecord(record_type) → {null}

+ + +
+
+ + +
+ Requests a newly initialized record from NetSuite. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record_type + + +string + + + + The String representing a record type
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

<static> insertLineItem(record, sublist_name, index) → {null}

+ + +
+
+ + +
+ Inserts a line item into a sublist on a given record. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record + + +nlobjRecord + + + + The NetsuiteRecord object
sublist_name + + +string + + + + The String representing the NetSuite sublist on the record
index + + +number + + + + The Number of the sublist index to be updated
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

<static> loadRecord(record_type, interal_id) → {null}

+ + +
+
+ + +
+ Requests a record from NetSuite's database by id (internal_id in NetSuite parlance) +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record_type + + +string + + + + The String representing a record type
interal_id + + +string + + + + The String representing a NetSuite internal_id
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

<static> removeLineItem(record, sublist_name, index) → {null}

+ + +
+
+ + +
+ Removes a line item at a given index for a given sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record + + +nlobjRecord + + + + The NetSuite record object
sublist_name + + +string + + + + The string representing the name of the sublist field
index + + +number + + + + The number of the sublist index
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

<static> setFieldValue(record, field_name, value) → {null}

+ + +
+
+ + +
+ Mutates an arbitrary field value on a NetSuite record. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record + + +nlobjRecord + + + + The NetSuite record object
field_name + + +string + + + + The String representing the field to mutate
value + + +value + + + + The String representing the value to replace
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

<static> setLineItemValue(record, sublist_name, index, field_name, value) → {null}

+ + +
+
+ + +
+ Mutates the value of a line item in a given sublist for a given field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record + + +nlobjRecord + + + + The NetSuite record object
sublist_name + + +string + + + + The String representing the NetSuite sublist
index + + +number + + + + The Number of the sublist index
field_name + + +string + + + + The string representing the name of the field
value + + +string + + + + The string representing the value of the field
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

<static> submitRecord(record, do_sourcing, ignore_mandatory) → {null}

+ + +
+
+ + +
+ Requests that Netsuite write a given record to it's database. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record + + +nlobjRecord + + + + The NetSuite record object
do_sourcing + + +boolean + + + + Enable or disable sourcing
ignore_mandatory + + +boolean + + + + Recognize or ignore mandatory fields
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/UpsertRequest.html b/doc/UpsertRequest.html new file mode 100644 index 0000000..bb9f6fc --- /dev/null +++ b/doc/UpsertRequest.html @@ -0,0 +1,638 @@ + + + + + JSDoc: Class: UpsertRequest + + + + + + + + + + +
+ +

Class: UpsertRequest

+ + + + + +
+ +
+

+ UpsertRequest +

+ +
+ +
+
+ + + + +
+

new UpsertRequest(record_data) → {Loader}

+ + +
+
+ + +
+ UpsertRequest Class +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
record_data + + +object + + + + The data from a client request
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ A new instance of UpsertRequest +
+ + + +
+
+ Type +
+
+ +Loader + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

execute() → {null}

+ + +
+
+ + +
+ Performs the UpsertRequest +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

executeSublistProcessor() → {null}

+ + +
+
+ + +
+ Initializes and calls `execute()` on the `NetsuiteToolkit.SublistProcessor()` +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

generateReply() → {object}

+ + +
+
+ + +
+ Calls `NetsuiteToolkit.formatReply()` passing it `params` and `written_id` +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ Formatted reply +
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + +
+ + + +
+

loadOrInitializeRecord() → {null}

+ + +
+
+ + +
+ Finds or creates a new record based on the presence of `internalid` +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ + + +
+

processSublists() → {null}

+ + +
+
+ + +
+ Iterates through given sublists calling `executeSublistProcessor()` +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +null + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/Upserter.html b/doc/Upserter.html new file mode 100644 index 0000000..c1a298d --- /dev/null +++ b/doc/Upserter.html @@ -0,0 +1,306 @@ + + + + + JSDoc: Class: Upserter + + + + + + + + + + +
+ +

Class: Upserter

+ + + + + +
+ +
+

+ Upserter +

+ +
+ +
+
+ + + + +
+

new Upserter(request) → {Upserter}

+ + +
+
+ + +
+ Upserter Class +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
request + + +object + + + + The body of the HTTP Post request from the client
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ A new instance of Upserter +
+ + + +
+
+ Type +
+
+ +Upserter + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

generateReply() → {object}

+ + +
+
+ + +
+ Generate a body for the reply to the client's request. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ The object containing a formatted summary of the results of the request +
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/global.html b/doc/global.html new file mode 100644 index 0000000..e075f83 --- /dev/null +++ b/doc/global.html @@ -0,0 +1,210 @@ + + + + + JSDoc: Namespace: global + + + + + + + + + + +
+ +

Namespace: global

+ + + + + +
+ +
+

+ global +

+ +
+ +
+
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

<static> loadPostHandler() → {object}

+ + +
+
+ + +
+ The script function that Netsuite will call to execute the Loader process +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ The formatted results of the request +
+ + + +
+
+ Type +
+
+ +object + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..8cd1a5f --- /dev/null +++ b/doc/index.html @@ -0,0 +1,90 @@ + + + + + JSDoc: Index + + + + + + + + + + +
+ +

Index

+ + + + + + + +

+ + + + + + + + + + + + + + +
+

rest_suite

+ +

Server-side Javascript library that wraps parts of the Netsuite SuiteScript API

+ +

note

+ +
  • when id is seen, it can generally be assumed to be internal_id in netsuite
  • each script is its own endpoint
  • every object within the scrips are private
  • every endpoint is a post
  • actions are taken based on the request body of the post
  • netsuite documentation is provided in doc/netsuite/index.html
  • project documentation is provided at doc/index.html
+ +

data-struct reference

+ +

Build out README sections to explain each key.

+ +
+ single record action
+  - id
+  - record_type
+  + literals
+    + sublists
+      - name
+      + line_items
+        + create_or_update
+          - match_field
+          - literals
+        + excise
+          - match_field (unique field to search against)
+          - value
+
+ + + + + + +
+ + + +
+ + + + + + diff --git a/doc/initialize.js.html b/doc/initialize.js.html new file mode 100644 index 0000000..2146e2c --- /dev/null +++ b/doc/initialize.js.html @@ -0,0 +1,99 @@ + + + + + JSDoc: Source: initialize.js + + + + + + + + + + +
+ +

Source: initialize.js

+ + + + + +
+
+ 
/**
+ * Initializer Class
+ * @class Initializer
+ * @param {object} request The body of the HTTP Post request from the client
+ * @return {Initializer} A new instance of Initializer
+ */
+this.Initializer = (function() {
+
+  /* @consturctor */
+  function Initializer(request) {
+    this.params             = request;
+    this.record_type        = request['record_type'];
+    this.initialized_record = null;
+    this.exception          = null;
+  }
+
+  /**
+   * Request the NetsuiteToolkit to return a new, blank record.
+   *
+   * @method
+   * @memberof Initializer
+   * @return {null}
+   */
+  Initializer.prototype.initializeRecord = function() {
+    try {
+      this.initialized_record = NetsuiteToolkit.initializeRecord(this.record_type);
+    } catch(exception) {
+      this.exception = exception;
+    }
+  }
+
+  /**
+   * Return a formatted reply object generate by NetsuiteToolkit
+   *
+   * @method
+   * @memberof Initializer
+   * @return {object} The object containing the formatted reply data
+   */
+  Initializer.prototype.generateReply = function() {
+    return NetsuiteToolkit.formatReply(this.params, this.initialized_record, this.exception);
+  }
+
+  return Initializer;
+})();
+
+var postHandler = function(request) {
+  initializer = new Initializer(request);
+  initializer.initializeRecord();
+  return initializer.generateReply();
+}
+
+
+
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/load.js.html b/doc/load.js.html new file mode 100644 index 0000000..d36bff7 --- /dev/null +++ b/doc/load.js.html @@ -0,0 +1,211 @@ + + + + + JSDoc: Source: load.js + + + + + + + + + + +
+ +

Source: load.js

+ + + + + +
+
+ 
/**
+ * Loader Class
+ * @class Loader
+ * @param {object} request The body of the HTTP Post request from the client
+ * @return {Loader} A new instance of Loader
+ */
+this.Loader = (function() {
+  
+  /** @constructor */
+  // FIXME (JamesChristie+nilmethod) document post body input
+  function Loader(request) {
+    this.params      = request;
+    this.result_list = [];
+    this.exception   = null;
+  };
+
+  /** 
+   * Iterate through the supplied parameters and load their related 
+   * records from NetSuite. Populate result_list or exception accordingly.
+   * 
+   * @method
+   * @memberof Loader
+   * @return {null}
+   */
+  Loader.prototype.loadRecords = function() {
+    try {
+      for(index in this.params) {
+        load_params = this.params[index];
+        this.executeLoadRequest(load_params);
+      }
+    } catch(exception) {
+      this.exception = exception;
+    }
+  }
+
+  /**
+   * Instantiate a new LoadRequest given load parameters and accumulate its result
+   * on result_list.
+   * 
+   * @method
+   * @memberof Loader
+   * @return {null}
+   */
+  Loader.prototype.executeLoadRequest = function(load_params) {
+    load_request = new LoadRequest(load_params['record_type'], load_params['internalid']);
+    this.accumulateResult(load_request.execute());
+  }
+
+  /**
+   * Push a result onto the result_list.
+   * 
+   * @method
+   * @memberof Loader
+   * @return {null}
+   */
+  Loader.prototype.accumulateResult = function(result) {
+    this.result_list.push(result);
+  }
+  
+  /**
+   * Generate and return Loader reply for the requestor.
+   * 
+   * @method
+   * @memberof Loader
+   * @return {object} A formatted reply object from NetsuiteToolkit
+   */
+  Loader.prototype.generateReply = function() {
+    return NetsuiteToolkit.formatReply(this.params, this.result_list, this.exception);
+  }
+
+  return Loader;
+})();
+
+/**
+ * LoadRequest Class
+ * @class LoadRequest
+ * @param {string} record_type the String representing a NetSuite record type
+ * @param {string} internalid the String representing a NetSuite internal id
+ * @return {LoadRequest} A new instance of LoadRequest
+ */
+this.LoadRequest = (function() {
+
+  /** @constructor */
+  function LoadRequest(record_type, internalid) {
+    this.record_type = record_type;
+    this.internalid  = internalid;
+    this.record      = null;
+    this.exception   = null;
+  }
+
+  /**
+   * Load a record for a LoadRequest and generate a reply for it.
+   *
+   * @method
+   * @memberof LoadRequest
+   * @return {null}
+   */
+  LoadRequest.prototype.execute = function() {
+    this.loadRecord();
+    return this.generateReply();
+  }
+
+
+  /**
+   * Load a record for a LoadRequest and catch any exceptions.
+   * 
+   * @method
+   * @memberof LoadRequest
+   * @return {null}
+   */
+  LoadRequest.prototype.loadRecord = function() {
+    try {
+      this.record = NetsuiteToolkit.loadRecord(this.record_type, this.internalid);
+    } catch(exception) {
+      this.exception = exception;
+    }
+  }
+  
+  /**
+   * Set parameters for a LoadRequest.
+   * 
+   * @method
+   * @memberof LoadRequest
+   * @return {object} The parameter object
+   */
+  LoadRequest.prototype.generateParams = function() {
+    params = {
+      'internalid':  this.internalid,
+      'record_type': this.record_type
+    };
+    return params;
+  }
+
+  /**
+   * Generate a LoadRequest reply for the requestor.
+   * 
+   * @method
+   * @memberof LoadRequest
+   * @return {object} A formatted reply object from NetsuiteToolkit
+   */
+  LoadRequest.prototype.generateReply = function() {
+    params = this.generateParams();
+    return NetsuiteToolkit.formatReply(params, this.record, this.exception);
+  }
+
+  return LoadRequest;
+})();
+
+/** @namespace global */
+
+/**
+ * The script function that Netsuite will call to execute the Loader process
+ * 
+ * @method
+ * @memberof global
+ * @return {object} The formatted results of the request
+ */
+var loadPostHandler = function(request) {
+  loader = new Loader(request);
+  loader.loadRecords();
+  return loader.generateReply();
+}
+
+
+
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/README.md b/doc/netsuite/README.md new file mode 100644 index 0000000..978a948 --- /dev/null +++ b/doc/netsuite/README.md @@ -0,0 +1 @@ +This is the SuiteScript v2010.1 documentation provided by NetSuite, generated by jsdoc3 provided for reference only. No code is provided from NetSuite. diff --git a/doc/netsuite/global.html b/doc/netsuite/global.html new file mode 100644 index 0000000..d9dea8e --- /dev/null +++ b/doc/netsuite/global.html @@ -0,0 +1,20418 @@ + + + + + JSDoc: Global + + + + + + + + + + +
+ +

Global

+ + + + + +
+ +
+

+ +

+ +
+ +
+
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

createSubrecord(fldnam)

+ + +
+
+ + +
+ create a subrecord on body field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + body field name
+ + + +
+ + + + + +
Since:
+
  • 2011.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

editSubrecord(fldnam)

+ + +
+
+ + +
+ edit a subrecord on body field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + body field name
+ + + +
+ + + + + +
Since:
+
  • 2011.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

nlapiAddDays(d, days) → {date}

+ + +
+
+ + +
+ Add days to a Date object and returns a new Date +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
d + + +date + + + + date object used to calculate the new date
days + + +int + + + + the number of days to add to this date object.
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +date + + +
+
+ + + + +
+ + + +
+

nlapiAddMonths(d, months) → {date}

+ + +
+
+ + +
+ Add months to a Date object and returns a new Date. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
d + + +date + + + + date object used to calculate the new date
months + + +int + + + + the number of months to add to this date object.
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +date + + +
+
+ + + + +
+ + + +
+

nlapiAttachRecord(type1, id1, type2, id2, properties) → {void}

+ + +
+
+ + +
+ Attach a single record to another with optional properties. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type1 + + +string + + + + + + + + The record type name being attached
id1 + + +int + + + + + + + + The internal ID for the record being attached
type2 + + +string + + + + + + + + The record type name being attached to
id2 + + +int + + + + + + + + The internal ID for the record being attached to
properties + + +Object + + + + + + <optional>
+ + + + 		Object containing name/value pairs used to configure attach operation
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiCancelLineItem(type) → {void}

+ + +
+
+ + +
+ Cancel any changes made on the currently selected line. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiCommitLineItem(type) → {void}

+ + +
+
+ + +
+ Save changes made on the currently selected line to the sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiCopyRecord(type, id, initializeValues) → {nlobjRecord}

+ + +
+
+ + +
+ Return a new record using values from an existing record. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + The record type name.
id + + +int + + + + The internal ID for the record.
initializeValues + + +Object + + + + Contains an array of name/value pairs of defaults to be used during record initialization.
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ Returns an nlobjRecord object of a copied record. +
+ + + +
+
+ Type +
+
+ +nlobjRecord + + +
+
+ + + + +
+ + + +
+

nlapiCreateAssistant(title, hideHeader) → {nlobjAssistant}

+ + +
+
+ + +
+ Return a new assistant page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
title + + +string + + + + + + + + page title
hideHeader + + +boolean + + + + + + <optional>
+ + + + 		true to hide the page header (false by default)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjAssistant + + +
+
+ + + + +
+ + + +
+

nlapiCreateCurrentLineSubrecord(type, fldnam)

+ + +
+
+ + +
+ Create a subrecord on a sublist field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
+ + + +
+ + + + + +
Since:
+
  • 2011.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

nlapiCreateError(code, details, suppressEmail) → {nlobjError}

+ + +
+
+ + +
+ Create an nlobjError object that can be used to abort script execution and configure error notification +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
code + + +string + + + + + + + + error code
details + + +string + + + + + + + + error description
suppressEmail + + +boolean + + + + + + <optional>
+ + + + 		if true then suppress the error notification emails from being sent out (false by default).
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjError + + +
+
+ + + + +
+ + + +
+

nlapiCreateFile(name, type, contents) → {nlobjFile}

+ + +
+
+ + +
+ Instantiate a file object (specifying the name, type, and contents which are base-64 encoded for binary types.) +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + file name
type + + +string + + + + file type i.e. plainText, htmlDoc, pdf, word (see documentation for the list of supported file types)
contents + + +string + + + + string containing file contents (must be base-64 encoded for binary types)
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFile + + +
+
+ + + + +
+ + + +
+

nlapiCreateForm(title, hideHeader) → {nlobjForm}

+ + +
+
+ + +
+ Return a new entry form page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
title + + +string + + + + + + + + page title
hideHeader + + +boolean + + + + + + <optional>
+ + + + 		true to hide the page header (false by default)
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjForm + + +
+
+ + + + +
+ + + +
+

nlapiCreateList(title, hideHeader) → {nlobjList}

+ + +
+
+ + +
+ Return a new list page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
title + + +string + + + + + + + + page title
hideHeader + + +boolean + + + + + + <optional>
+ + + + 		true to hide the page header (false by default)
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjList + + +
+
+ + + + +
+ + + +
+

nlapiCreateRecord(type, initializeValues) → {nlobjRecord}

+ + +
+
+ + +
+ Instantiate a new nlobjRecord object containing all the default field data for that record type. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + record type ID.
initializeValues + + +Object + + + + Contains an array of name/value pairs of defaults to be used during record initialization.
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + +
Throws:
+
    +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_RECORD_TYPE + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_TYPE_ARG_REQD + + +
    +
    +
    • +
+ + +
Returns:
+ + +
+ Returns an nlobjRecord object of a new record from the system. +
+ + + +
+
+ Type +
+
+ +nlobjRecord + + +
+
+ + + + +
+ + + +
+

nlapiDateToString(d, formattype) → {string}

+ + +
+
+ + +
+ Convert a Date object into a String +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
d + + +date + + + + + + + + date object being converted to a string
formattype + + +string + + + + + + <optional>
+ + + + 		format type to use: date|datetime|timeofday with date being the default
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiDeleteFile(id) → {id}

+ + +
+
+ + +
+ Delete a file from the file cabinet. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
id + + +int + + + + internal ID of file to be deleted
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +id + + +
+
+ + + + +
+ + + +
+

nlapiDeleteRecord(type, id) → {void}

+ + +
+
+ + +
+ Delete a record from the system. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + The record type name.
id + + +int + + + + The internal ID for the record.
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + +
Throws:
+
    +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_RECORD_TYPE + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_TYPE_ARG_REQD + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_INTERNAL_ID + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_ID_ARG_REQD + + +
    +
    +
    • +
+ + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiDetachRecord(type1, id1, type2, id2, properties) → {void}

+ + +
+
+ + +
+ Detach a single record from another with optional properties. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type1 + + +string + + + + + + + + The record type name being attached
id1 + + +int + + + + + + + + The internal ID for the record being attached
type2 + + +string + + + + + + + + The record type name being attached to
id2 + + +int + + + + + + + + The internal ID for the record being attached to
properties + + +Object + + + + + + <optional>
+ + + + 		Object containing name/value pairs used to configure detach operation
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiEditCurrentLineItemSubrecord(type, fldnam)

+ + +
+
+ + +
+ edit a subrecord on a sublist field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
+ + + +
+ + + + + +
Since:
+
  • 2011.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

nlapiEncrypt(s) → {string}

+ + +
+
+ + +
+ Encrypt a String using a SHA-1 hash function +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
s + + +string + + + + string to encrypt
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiEscapeXML(text) → {string}

+ + +
+
+ + +
+ Escape a String for use in an XML document. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
text + + +string + + + + string to escape
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiExchangeRate(fromCurrency, toCurrency, date) → {float}

+ + +
+
+ + +
+ Calculate exchange rate between two currencies as of today or an optional effective date. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
fromCurrency + + +string, int + + + + + + + + internal ID or currency code of currency we are converting from
toCurrency + + +string, int + + + + + + + + internal ID or currency code of currency we are converting to
date + + +string + + + + + + <optional>
+ + + + 		string containing date of effective exchange rate. defaults to today
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +float + + +
+
+ + + + +
+ + + +
+

nlapiFindLineItemMatrixValue(type, fldnam, column, val) → {int}

+ + +
+
+ + +
+ Return the 1st line number that a matrix field value appears in +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + matrix field name
column + + +int + + + + matrix column index (1-based)
val + + +string + + + + the value being queried for in a matrix field
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiFindLineItemValue(type, fldnam, val) → {int}

+ + +
+
+ + +
+ Return the 1st line number that a sublist field value appears in +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
val + + +string + + + + the value being queried for in a sublist field
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiFormatCurrency(str) → {string}

+ + +
+
+ + +
+ Format a number for data entry into a currency field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
str + + +string + + + + numeric string used to format for display as currency using user's locale
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiGetContext() → {nlobjContext}

+ + +
+
+ + +
+ Return context information about the current user/script. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjContext + + +
+
+ + + + +
+ + + +
+

nlapiGetCurrentLineItemIndex(type) → {int}

+ + +
+
+ + +
+ Return the line number for the currently selected line. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiGetCurrentLineItemMatrixValue(type, fldnam, column) → {string}

+ + +
+
+ + +
+ Get the current value of a sublist field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
column + + +int + + + + matrix column index (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ value +
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiGetCurrentLineItemText(type, fldnam) → {string}

+ + +
+
+ + +
+ Return the label of a select field's current selection on the currently selected line. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiGetCurrentLineItemValue(type, fldnam) → {string}

+ + +
+
+ + +
+ Return the value of a field on the currently selected line. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiGetDepartment() → {int}

+ + +
+
+ + +
+ Return the internal ID for the current user's department. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiGetField(fldnam) → {nlobjField}

+ + +
+
+ + +
+ Return field definition for a field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + the name of the field
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

nlapiGetFieldMandatory(fldnam) → {boolean}

+ + +
+
+ + +
+ Return field mandatoriness. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ + + +
+

nlapiGetFieldText(fldnam) → {string}

+ + +
+
+ + +
+ Return the display value of a select field's current selection on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + the field name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiGetFieldTexts(fldnam) → {string[]}

+ + +
+
+ + +
+ Return the values (via display text) of a multiselect field on the current record. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

nlapiGetFieldValue(fldnam) → {string}

+ + +
+
+ + +
+ Return the value of a field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + the field name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiGetFieldValues(fldnam) → {string[]}

+ + +
+
+ + +
+ Return the values of a multiselect field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + the field name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

nlapiGetLineItemCount(type) → {int}

+ + +
+
+ + +
+ Return the number of sublists in a sublist on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiGetLineItemField(type, fldnam, linenum) → {nlobjField}

+ + +
+
+ + +
+ Return field definition for a sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + sublist name
fldnam + + +string + + + + + + + + sublist field name
linenum + + +int + + + + + + <optional>
+ + + + 		line number for sublist field (1-based) and only valid for sublists of type staticlist and list
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

nlapiGetLineItemMandatory(type, fldnam) → {boolean}

+ + +
+
+ + +
+ Return sublist field mandatoriness. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ + + +
+

nlapiGetLineItemMatrixField(type, fldnam, linenum, column) → {nlobjField}

+ + +
+
+ + +
+ Return an nlobjField containing sublist field metadata. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + matrix sublist name
fldnam + + +string + + + + matrix field name
linenum + + +int + + + + line number (1-based)
column + + +int + + + + matrix column index (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

nlapiGetLineItemMatrixValue(type, fldnam, linenum, column, value)

+ + +
+
+ + +
+ Return the value of a sublist matrix field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
linenum + + +int + + + + line number (1-based)
column + + +int + + + + column index (1-based)
value + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

nlapiGetLineItemText(type, fldnam, linenum) → {string}

+ + +
+
+ + +
+ Return the label of a select field's current selection for a particular line. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
linenum + + +int + + + + line number (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiGetLineItemValue(type, fldnam, linenum) → {string}

+ + +
+
+ + +
+ Return the value of a sublist field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
linenum + + +int + + + + line number (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiGetLocation() → {int}

+ + +
+
+ + +
+ Return the internal ID for the current user's location. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiGetMatrixCount(type, fldnam) → {int}

+ + +
+
+ + +
+ Return the number of columns for a matrix field +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + matrix field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiGetMatrixField(type, fldnam, column) → {nlobjField}

+ + +
+
+ + +
+ Return field definition for a matrix field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + matrix sublist name
fldnam + + +string + + + + matrix field name
column + + +int + + + + matrix field column index (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

nlapiGetMatrixValue(type, fldnam, column) → {string}

+ + +
+
+ + +
+ Get the value of a matrix header field +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
column + + +int + + + + matrix column index (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiGetNewRecord() → {nlobjRecord}

+ + +
+
+ + +
+ Return an record object containing the data being submitted to the system for the currenr record. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjRecord + + +
+
+ + + + +
+ + + +
+

nlapiGetOldRecord() → {nlobjRecord}

+ + +
+
+ + +
+ Return an record object containing the current record's data prior to the write operation. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjRecord + + +
+
+ + + + +
+ + + +
+

nlapiGetRecordId() → {int}

+ + +
+
+ + +
+ Return the internal ID corresponding to the current page or userevent script. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiGetRecordType() → {string}

+ + +
+
+ + +
+ Return the recordtype corresponding to the current page or userevent script. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiGetRole() → {int}

+ + +
+
+ + +
+ Return the internal ID for the current user's role. Returns 31 (Online Form User) when called from online forms or "Available without Login" Suitelets. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiGetSubsidiary() → {int}

+ + +
+
+ + +
+ Return the internal ID for the current user's subsidiary. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiGetUser() → {int}

+ + +
+
+ + +
+ Return the internal ID for the currently logged in user. Returns -4 when called from online forms or "Available without Login" Suitelets. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiInitiateWorkflow(recordtype, id, workflowid) → {int}

+ + +
+
+ + +
+ Initiates a workflow on-demand and returns the workflow instance ID for the workflow-record combination. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
recordtype + + +string + + + + record type ID of the workflow base record
id + + +int + + + + internal ID of the base record
workflowid + + +string, int + + + + internal ID or script ID for the workflow definition
+ + + +
+ + + + + +
Since:
+
  • 2010.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiInsertLineItem(type, line)

+ + +
+
+ + +
+ Insert and select a new line into the sublist on a page or userevent. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + sublist name
line + + +int + + + + + + <optional>
+ + + + 		line number at which to insert a new line.
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

nlapiInsertLineItemOption(type, fldnam, value, text, selected) → {void}

+ + +
+
+ + +
+ Adds a select option to a scripted select or multiselect sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + sublist name
fldnam + + +string + + + + + + + + sublist field name
value + + +string + + + + + + + + internal ID for select option
text + + +string + + + + + + + + display text for select option
selected + + +boolean + + + + + + <optional>
+ + + + 		if true then option will be selected by default
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiInsertSelectOption(fldnam, value, text, selected) → {void}

+ + +
+
+ + +
+ Adds a select option to a scripted select or multiselect field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
fldnam + + +string + + + + + + + + field name
value + + +string + + + + + + + + internal ID for select option
text + + +string + + + + + + + + display text for select option
selected + + +boolean + + + + + + <optional>
+ + + + 		if true then option will be selected by default
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiIsLineItemChanged(type) → {boolean}

+ + +
+
+ + +
+ Returns true if any changes have been made to a sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ + + +
+

nlapiLoadConfiguration(type) → {nlobjConfiguration}

+ + +
+
+ + +
+ Loads a configuration record +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjConfiguration + + +
+
+ + + + +
+ + + +
+

nlapiLoadFile(id) → {nlobjFile}

+ + +
+
+ + +
+ Load a file from the file cabinet (via its internal ID or path). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
id + + +string, int + + + + internal ID or relative path to file in the file cabinet (i.e. /SuiteScript/foo.js)
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFile + + +
+
+ + + + +
+ + + +
+

nlapiLoadRecord(type, id, initializeValues) → {nlobjRecord}

+ + +
+
+ + +
+ Load an existing record from the system. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + The record type name.
id + + +int + + + + The internal ID for the record.
initializeValues + + +Object + + + + Contains an array of name/value pairs of defaults to be used during record initialization.
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + +
Throws:
+
    +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_RECORD_TYPE + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_TYPE_ARG_REQD + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_INTERNAL_ID + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_ID_ARG_REQD + + +
    +
    +
    • +
+ + +
Returns:
+ + +
+ Returns an nlobjRecord object of an existing NetSuite record. +
+ + + +
+
+ Type +
+
+ +nlobjRecord + + +
+
+ + + + +
+ + + +
+

nlapiLogExecution(type, title, details) → {void}

+ + +
+
+ + +
+ Create an entry in the script execution log (note that execution log entries are automatically purged after 30 days). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + log type: debug|audit|error|emergency
title + + +string + + + + + + + + log title (up to 90 characters supported)
details + + +string + + + + + + <optional>
+ + + + 		log details (up to 3000 characters supported)
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiLookupField(type, id, fields, text) → {string, Object}

+ + +
+
+ + +
+ Fetch the value of one or more fields on a record. This API uses search to look up the fields and is much +faster than loading the record in order to get the field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + The record type name.
id + + +int + + + + + + + + The internal ID for the record.
fields + + +string, string[] + + + + + + + + field or fields to look up.
text + + +boolean + + + + + + <optional>
+ + + + 		If set then the display value is returned instead for select fields.
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ single value or an Object of field name/value pairs depending on the fields argument. +
+ + + +
+
+ Type +
+
+ +string, Object + + +
+
+ + + + +
+ + + +
+

nlapiMergeRecord(id, baseType, baseId, altType, altId, fields) → {nlobjFile}

+ + +
+
+ + +
+ Perform a mail merge operation using any template and up to 2 records and returns an nlobjFile with the results. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
id + + +int + + + + + + + + internal ID of template
baseType + + +string + + + + + + + + primary record type
baseId + + +int + + + + + + + + internal ID of primary record
altType + + +string + + + + + + <optional>
+ + + + 		secondary record type
altId + + +int + + + + + + <optional>
+ + + + 		internal ID of secondary record
fields + + +Object + + + + + + <optional>
+ + + + 		Object of merge field values to use in the mail merge (by default all field values are obtained from records) which overrides those from the record.
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFile + + +
+
+ + + + +
+ + + +
+

nlapiOutboundSSO(ssoAppKey) → {string}

+ + +
+
+ + +
+ Return a URL with a generated OAuth token. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
ssoAppKey + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiPrintRecord(type, id, format, properties) → {nlobjFile}

+ + +
+
+ + +
+ Print a record (transaction) gievn its type, id, and output format. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + print output type: transaction|statement|packingslip|pickingticket
id + + +int + + + + + + + + internal ID of record to print
format + + +string + + + + + + <optional>
+ + + + 		output format: html|pdf|default
properties + + +Object + + + + + + <optional>
+ + + + 		Object of properties used to configure print
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFile + + +
+
+ + + + +
+ + + +
+

nlapiRefreshLineItems(type)

+ + +
+
+ + +
+ Refresh the sublist table. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

nlapiRemoveCurrentLineItemSubrecord(type, fldnam)

+ + +
+
+ + +
+ remove a subrecord on a sublist field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
+ + + +
+ + + + + +
Since:
+
  • 2011.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

nlapiRemoveLineItem(type, line) → {void}

+ + +
+
+ + +
+ Remove the currently selected line from the sublist on a page or userevent. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + sublist name
line + + +int + + + + + + <optional>
+ + + + 		line number to remove.
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiRemoveLineItemOption(type, fldnam, value) → {void}

+ + +
+
+ + +
+ Removes a select option (or all if value is null) from a scripted select or multiselect sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
value + + +string + + + + internal ID for select option to remove
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiRemoveSelectOption(fldnam, value) → {void}

+ + +
+
+ + +
+ Removes a select option (or all if value is null) from a scripted select or multiselect field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + field name
value + + +string + + + + internal ID of select option to remove
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiRequestURL(url, postdata, headers, callback) → {nlobjServerResponse}

+ + +
+
+ + +
+ Request a URL to an external or internal resource. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
url + + +string + + + + + + + + A fully qualified URL to an HTTP(s) resource
postdata + + +string, Object + + + + + + <optional>
+ + + + 		string, document, or Object containing POST payload
headers + + +Object + + + + + + <optional>
+ + + + 		Object containing request headers.
callback + + +function + + + + + + <optional>
+ + + + 		available on the Client to support asynchronous requests. function is passed an nlobjServerResponse with the results.
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + +
Throws:
+
    +
  • + + +
    +
    + Type +
    +
    + +SSS_UNKNOWN_HOST + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_HOST_CERT + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_REQUEST_TIME_EXCEEDED + + +
    +
    +
    • +
+ + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjServerResponse + + +
+
+ + + + +
+ + + +
+

nlapiResolveURL(type, subtype, id, pagemode) → {string}

+ + +
+
+ + +
+ Resolve a URL to a resource or object in the system. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + type specifier for URL: suitelet|tasklink|record|mediaitem
subtype + + +string + + + + + + + + subtype specifier for URL (corresponding to type): scriptid|taskid|recordtype|mediaid
id + + +string + + + + + + <optional>
+ + + + 		internal ID specifier (sub-subtype corresponding to type): deploymentid|n/a|recordid|n/a
pagemode + + +string + + + + + + <optional>
+ + + + 		string specifier used to configure page (suitelet: external|internal, tasklink|record: edit|view)
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiScheduleScript(script, deployment, parameters) → {string}

+ + +
+
+ + +
+ Queue a scheduled script for immediate execution and return the status QUEUED if successfull. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
script + + +string, int + + + + + + + + script ID or internal ID of scheduled script
deployment + + +string, int + + + + + + <optional>
+ + + + 		script ID or internal ID of scheduled script deployment. If empty, the first "free" deployment (i.e. status = Not Scheduled or Completed) will be used
parameters + + +Object + + + + + + + + Object of parameter name->values used in this scheduled script instance
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ QUEUED or null if no available deployments were found or the current status of the deployment specified if it was not available. +
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiSearchDuplicate(type, fields, id) → {nlobjSearchResult[]}

+ + +
+
+ + +
+ Perform a duplicate record search using Duplicate Detection criteria. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + The recordType you are checking duplicates for (for example, customer|lead|prospect|partner|vendor|contact).
fields + + +string[] + + + + + + <optional>
+ + + + 		array of field names used to detect duplicate (for example, companyname|email|name|phone|address1|city|state|zipcode).
id + + +int + + + + + + <optional>
+ + + + 		internal ID of existing record. Depending on the use case, id may or may not be a required argument.
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ Returns an Array of nlobjSearchResult objects corresponding to the duplicate records. +
+ + + +
+
+ Type +
+
+ +nlobjSearchResult[] + + +
+
+ + + + +
+ + + +
+

nlapiSearchGlobal(keywords) → {nlobjSearchResult[]}

+ + +
+
+ + +
+ Perform a global record search across the system. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
keywords + + +string + + + + Global search keywords string or expression.
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ Returns an Array of nlobjSearchResult objects containing the following four columns: name, type (as shown in the UI), info1, and info2. +
+ + + +
+
+ Type +
+
+ +nlobjSearchResult[] + + +
+
+ + + + +
+ + + +
+

nlapiSearchRecord(type, id, filters, columns) → {nlobjSearchResult[]}

+ + +
+
+ + +
+ Perform a record search using an existing search or filters and columns. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + record type ID.
id + + +int, string + + + + + + <optional>
+ + + + 		The internal ID or script ID for the saved search to use for search.
filters + + +nlobjSearchFilter, nlobjSearchFilter[] + + + + + + <optional>
+ + + + 		[optional] A single nlobjSearchFilter object - or - an array of nlobjSearchFilter objects.
columns + + +nlobjSearchColumn, nlobjSearchColumn[] + + + + + + <optional>
+ + + + 		[optional] A single nlobjSearchColumn object - or - an array of nlobjSearchColumn objects.
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + +
Throws:
+
    +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_RECORD_TYPE + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_TYPE_ARG_REQD + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_SRCH_ID + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_SRCH_FILTER + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_SRCH_FILTER_JOIN + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_SRCH_OPERATOR + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_SRCH_COL_NAME + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_SRCH_COL_JOIN + + +
    +
    +
    • +
+ + +
Returns:
+ + +
+ Returns an array of nlobjSearchResult objects corresponding to the searched records. +
+ + + +
+
+ Type +
+
+ +nlobjSearchResult[] + + +
+
+ + + + +
+ + + +
+

nlapiSelectLineItem(type, linenum) → {void}

+ + +
+
+ + +
+ Select an existing line in a sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
linenum + + +int + + + + line number to select
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSelectNewLineItem(type) → {void}

+ + +
+
+ + +
+ Select a new line in a sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSelectNode(node, xpath) → {node}

+ + +
+
+ + +
+ Select a node from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix) +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
node + + +node + + + + node being queried
xpath + + +string + + + + string containing XPath expression.
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +node + + +
+
+ + + + +
+ + + +
+

nlapiSelectNodes(node, xpath) → {node[]}

+ + +
+
+ + +
+ Select an array of nodes from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix) +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
node + + +node + + + + node being queried
xpath + + +string + + + + string containing XPath expression.
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +node[] + + +
+
+ + + + +
+ + + +
+

nlapiSelectValue(node, xpath) → {string}

+ + +
+
+ + +
+ select a value from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix) +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
node + + +node + + + + node being queried
xpath + + +string + + + + string containing XPath expression.
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiSelectValues(node, xpath) → {string[]}

+ + +
+
+ + +
+ Select an array of values from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix) +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
node + + +node + + + + node being queried
xpath + + +string + + + + string containing XPath expression.
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

nlapiSendCampaignEmail(campaigneventid, recipientid) → {int}

+ + +
+
+ + +
+ Sends a single on-demand campaign email to a specified recipient and returns a campaign response ID to track the email. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
campaigneventid + + +int + + + + internal ID of the campaign event
recipientid + + +int + + + + internal ID of the recipient - the recipient must have an email
+ + + +
+ + + + + +
Since:
+
  • 2010.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiSendEmail(from, to, subject, body, cc, bcc, records, files) → {void}

+ + +
+
+ + +
+ Send out an email and associate it with records in the system. +Supported base types are entity for entities, transaction for transactions, activity for activities and cases, record|recordtype for custom records +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
from + + +int + + + + internal ID for employee user on behalf of whom this email is sent
to + + +string, int + + + + email address or internal ID of user that this email is being sent to
subject + + +string + + + + email subject
body + + +string + + + + email body
cc + + +string, string[] + + + + copy email address(es)
bcc + + +string, string[] + + + + blind copy email address(es)
records + + +Object + + + + Object of base types -> internal IDs used to associate email to records. i.e. {entity: 100, record: 23, recordtype: customrecord_surveys}
files + + +nlobjFile[] + + + + array of nlobjFile objects (files) to include as attachments
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSendFax(from, to, subject, body, records, files) → {void}

+ + +
+
+ + +
+ Send out a fax and associate it with records in the system. This requires fax preferences to be configured. +Supported base types are entity for entities, transaction for transactions, activity for activities and cases, record|recordtype for custom records +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
from + + +int + + + + internal ID for employee user on behalf of whom this fax is sent
to + + +string, int + + + + fax address or internal ID of user that this fax is being sent to
subject + + +string + + + + fax subject
body + + +string + + + + fax body
records + + +Object + + + + Object of base types -> internal IDs used to associate fax to records. i.e. {entity: 100, record: 23, recordtype: customrecord_surveys}
files + + +nlobjFile[] + + + + array of nlobjFile objects (files) to include as attachments
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetCurrentLineItemMatrixValue(type, fldnam, column, value, firefieldchanged, synchronous) → {void}

+ + +
+
+ + +
+ Set the current value of a sublist field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + sublist name
fldnam + + +string + + + + + + + + sublist field name
column + + +int + + + + + + + + matrix column index (1-based)
value + + +string + + + + + + + + matrix field value
firefieldchanged + + +boolean + + + + + + <optional>
+ + + + 		if false then the field change event is suppressed (defaults to true)
synchronous + + +boolean + + + + + + <optional>
+ + + + 		if true then sourcing and field change execution happens synchronously (defaults to false).
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetCurrentLineItemText(type, fldnam, txt, firefieldchanged, synchronous) → {void}

+ + +
+
+ + +
+ Set the value of a field on the currently selected line using it's label. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + sublist name
fldnam + + +string + + + + + + + + sublist field name
txt + + +string + + + + + + + + string containing display value or search text.
firefieldchanged + + +boolean + + + + + + <optional>
+ + + + 		if false then the field change event is suppressed (defaults to true)
synchronous + + +boolean + + + + + + <optional>
+ + + + 		if true then sourcing and field change execution happens synchronously (defaults to false).
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetCurrentLineItemValue(type, fldnam, value, firefieldchanged, synchronous) → {void}

+ + +
+
+ + +
+ Set the value of a field on the currently selected line. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + sublist name
fldnam + + +string + + + + + + + + sublist field name
value + + +string + + + + + + + + field value
firefieldchanged + + +boolean + + + + + + <optional>
+ + + + 		if false then the field change event is suppressed (defaults to true)
synchronous + + +boolean + + + + + + <optional>
+ + + + 		if true then sourcing and field change execution happens synchronously (defaults to false).
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetFieldMandatory(fldnam, mandatory) → {void}

+ + +
+
+ + +
+ Make a field mandatory. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + field name
mandatory + + +boolean + + + + if true then field is made mandatory
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetFieldText(fldnam, txt, firefieldchanged, synchronous) → {void}

+ + +
+
+ + +
+ Set the value of a field on the current record on a page using it's label. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
fldnam + + +string + + + + + + + + the field name
txt + + +string + + + + + + + + display name used to lookup field value
firefieldchanged + + +boolean + + + + + + <optional>
+ + + + 		if false then the field change event is suppressed (defaults to true)
synchronous + + +boolean + + + + + + <optional>
+ + + + 		if true then sourcing and field change execution happens synchronously (defaults to false).
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetFieldTexts(fldnam, texts, firefieldchanged, synchronous) → {void}

+ + +
+
+ + +
+ Set the values (via display text) of a multiselect field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
fldnam + + +string + + + + + + + + field name
texts + + +string[] + + + + + + + + array of strings containing display values for field
firefieldchanged + + +boolean + + + + + + <optional>
+ + + + 		if false then the field change event is suppressed (defaults to true)
synchronous + + +boolean + + + + + + <optional>
+ + + + 		if true then sourcing and field change execution happens synchronously (defaults to false).
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetFieldValue(fldnam, value, firefieldchanged, synchronous) → {void}

+ + +
+
+ + +
+ Set the value of a field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
fldnam + + +string + + + + + + + + the field name
value + + +string + + + + + + + + value used to set field
firefieldchanged + + +boolean + + + + + + <optional>
+ + + + 		if false then the field change event is suppressed (defaults to true)
synchronous + + +boolean + + + + + + <optional>
+ + + + 		if true then sourcing and field change execution happens synchronously (defaults to false).
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetFieldValues(fldnam, values, firefieldchanged, synchronous) → {void}

+ + +
+
+ + +
+ Set the values of a multiselect field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
fldnam + + +string + + + + + + + + field name
values + + +string[] + + + + + + + + array of strings containing values for field
firefieldchanged + + +boolean + + + + + + <optional>
+ + + + 		if false then the field change event is suppressed (defaults to true)
synchronous + + +boolean + + + + + + <optional>
+ + + + 		if true then sourcing and field change execution happens synchronously (defaults to false).
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetLineItemDisabled(type, fldnam, disable, linenum) → {void}

+ + +
+
+ + +
+ Disable a sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
disable + + +boolean + + + + if true then field is disabled
linenum + + +int + + + + line number for sublist field (1-based) and only valid for sublists of type list
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetLineItemMandatory(type, fldnam, mandatory) → {void}

+ + +
+
+ + +
+ Make a sublist field mandatory. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
mandatory + + +boolean + + + + if true then field is made mandatory
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetLineItemValue(type, fldnam, linenum, value)

+ + +
+
+ + +
+ Set the value of a sublist field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
linenum + + +int + + + + line number (1-based)
value + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

nlapiSetMatrixValue(type, fldnam, column, value, firefieldchanged, synchronous) → {void}

+ + +
+
+ + +
+ Set the value of a matrix header field +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + sublist name
fldnam + + +string + + + + + + + + sublist field name
column + + +int + + + + + + + + matrix column index (1-based)
value + + +string + + + + + + + + field value for matrix field
firefieldchanged + + +boolean + + + + + + <optional>
+ + + + 		if false then the field change event is suppressed (defaults to true)
synchronous + + +boolean + + + + + + <optional>
+ + + + 		if true then sourcing and field change execution happens synchronously (defaults to false).
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSetRedirectURL(type, subtype, id, pagemode, parameters) → {void}

+ + +
+
+ + +
+ Redirect the user to a page. Only valid in the UI on Suitelets and User Events. In Client scripts this will initialize the redirect URL used upon submit. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + type specifier for URL: suitelet|tasklink|record|mediaitem
subtype + + +string + + + + + + + + subtype specifier for URL (corresponding to type): scriptid|taskid|recordtype|mediaid
id + + +string + + + + + + <optional>
+ + + + 		internal ID specifier (sub-subtype corresponding to type): deploymentid|n/a|recordid|n/a
pagemode + + +string + + + + + + <optional>
+ + + + 		string specifier used to configure page (suitelet: external|internal, tasklink|record: edit|view)
parameters + + +Object + + + + + + <optional>
+ + + + 		Object used to specify additional URL parameters as name/value pairs
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiStringToDate(str, format) → {date}

+ + +
+
+ + +
+ Convert a String into a Date object. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
str + + +string + + + + date string in the user's date format, timeofday format, or datetime format
format + + +string + + + + format type to use: date|datetime|timeofday with date being the default
+ + + +
+ + + + + +
Since:
+
  • 2005.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +date + + +
+
+ + + + +
+ + + +
+

nlapiStringToXML(str) → {document}

+ + +
+
+ + +
+ Convert a String into an XML document. Note that in Server SuiteScript XML is supported natively by the JS runtime using the e4x standard (http://en.wikipedia.org/wiki/E4X) +This makes scripting XML simpler and more efficient +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
str + + +string + + + + string being parsed into an XML document
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +document + + +
+
+ + + + +
+ + + +
+

nlapiSubmitConfiguration(setup)

+ + +
+
+ + +
+ Commits all changes to a configuration record. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
setup + + +nlobjConfiguration + + + + record
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ (void) +
+ + + + + + +
+ + + +
+

nlapiSubmitField(type, id, fields, values, doSourcing) → {void}

+ + +
+
+ + +
+ Submit the values of a field or set of fields for an existing record. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + The record type name.
id + + +int + + + + + + + + The internal ID for the record.
fields + + +string, string[] + + + + + + + + field or fields being updated.
values + + +string, string[] + + + + + + + + field value or field values used for updating.
doSourcing + + +boolean + + + + + + <optional>
+ + + + 		If not set, this argument defaults to false and field sourcing does not occur.
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

nlapiSubmitFile(file) → {int}

+ + +
+
+ + +
+ Add/update a file in the file cabinet. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
file + + +nlobjFile + + + + a file object to submit
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ return internal ID of file +
+ + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiSubmitRecord(record, doSourcing, ignoreMandatoryFields) → {string}

+ + +
+
+ + +
+ Submit a record to the system for creation or update. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
record + + +nlobjRecord + + + + + + + + nlobjRecord object containing the data record.
doSourcing + + +boolean + + + + + + <optional>
+ + + + 		If not set, this argument defaults to false.
ignoreMandatoryFields + + +boolean + + + + + + <optional>
+ + + + 		Disables mandatory field validation for this submit operation.
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + +
Throws:
+
    +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_RECORD_OBJ + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_RECORD_OBJ_REQD + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_SOURCE_ARG + + +
    +
    +
    • +
+ + +
Returns:
+ + +
+ internal ID for committed record. +
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

nlapiTransformRecord(type, id, transformType, transformValues) → {nlobjRecord}

+ + +
+
+ + +
+ Create a new record using values from an existing record of a different type. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + The record type name.
id + + +int + + + + + + + + The internal ID for the record.
transformType + + +string + + + + + + + + The recordType you are transforming the existing record into.
transformValues + + +Object + + + + + + <optional>
+ + + + 		An object containing transform default option/value pairs used to pre-configure transformed record
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + +
Throws:
+
    +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_URL_CATEGORY + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_CATEGORY_ARG_REQD + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_TASK_ID + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_TASK_ID_REQD + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_INTERNAL_ID + + +
    +
    +
    • + +
  • + + +
    +
    + Type +
    +
    + +SSS_INVALID_EDITMODE_ARG + + +
    +
    +
    • +
+ + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjRecord + + +
+
+ + + + +
+ + + +
+

nlapiTriggerWorkflow(recordtype, id, workflowid, actionid) → {int}

+ + +
+
+ + +
+ Triggers a workflow on a record. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
recordtype + + +string + + + + record type ID of the workflow base record
id + + +int + + + + internal ID of the base record
workflowid + + +string, int + + + + internal ID or script ID for the workflow definition
actionid + + +string, int + + + + internal ID or script ID of the action script
+ + + +
+ + + + + +
Since:
+
  • 2010.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

nlapiViewCurrentLineItemSubrecord(type, fldnam)

+ + +
+
+ + +
+ view a subrecord on a sublist field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
+ + + +
+ + + + + +
Since:
+
  • 2011.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

nlapiViewLineItemSubrecord(type, fldnam)

+ + +
+
+ + +
+ view a subrecord on a sublist field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
+ + + +
+ + + + + +
Since:
+
  • 2011.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

nlapiXMLToPDF(input) → {nlobjFile}

+ + +
+
+ + +
+ Generate a PDF from XML using the BFO report writer (see http://big.faceless.org/products/report/). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
input + + +string + + + + string containing BFO compliant XHTML
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFile + + +
+
+ + + + +
+ + + +
+

nlapiXMLToString(xml) → {string}

+ + +
+
+ + +
+ Convert an XML document into a String. Note that in Server SuiteScript XML is supported natively by the JS runtime using the e4x standard (http://en.wikipedia.org/wiki/E4X) +This makes scripting XML data simpler and more efficient +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
xml + + +document + + + + document being serialized into a string
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

removeSubrecord(fldnam)

+ + +
+
+ + +
+ remove a subrecord on body field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + body field name
+ + + +
+ + + + + +
Since:
+
  • 2011.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

viewSubrecord(fldnam)

+ + +
+
+ + +
+ view a subrecord on body field on the current record on a page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + body field name
+ + + +
+ + + + + +
Since:
+
  • 2011.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/index.html b/doc/netsuite/index.html new file mode 100644 index 0000000..456058b --- /dev/null +++ b/doc/netsuite/index.html @@ -0,0 +1,66 @@ + + + + + JSDoc: Index + + + + + + + + + + +
+ +

Index

+ + + + + + + +

+ + + + + + + + + + + + + + +
+

This is the SuiteScript v2010.1 documentation provided by NetSuite, generated by jsdoc3 provided for reference only. No code is provided from NetSuite.

+
+ + + + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlapihandler_stubs.js b/doc/netsuite/nlapihandler_stubs.js new file mode 100644 index 0000000..0d85e35 --- /dev/null +++ b/doc/netsuite/nlapihandler_stubs.js @@ -0,0 +1,4890 @@ +/** +* @projectDescription SuiteScript JavaScript library summary. +* +* Note that there are some restrictions on API usage. Also note that the only 2 objects that can be +* contructed are nlobjSearchFilter and nlobjSearchColumn. All other objects can only be created via +* top-level function or method calls. +* +* The @governance tag refers to the usage governance for an API call +* The @restricted tag refers to any known restrictions with a particular API call +* +* All Object arguments are Javascript Objects used as hash tables for specifying key-value pairs +* +* @since 2005.0 Support scripting of current record in Client SuiteScript +* @version 2007.0 Support scripting of records in user events, portlets, and scheduled scripts +* @version 2008.1 Support scripting of web requests (Suitelets) and user interfaces (UI Object API) +* @version 2009.1 Support scripting of file objects +* @version 2009.2 Support scripting of setup records and assistant (multi-step) pages +* @version 2009.2 converted JS template to use eclipse code completion friendly format +* @version 2010.1 Suppport dynamic scripting +*/ + +/** + * Return a new record using values from an existing record. + * @governance 10 units for transactions, 2 for custom records, 4 for all other records + * + * @param {string} type The record type name. + * @param {int} id The internal ID for the record. + * @param {Object} initializeValues Contains an array of name/value pairs of defaults to be used during record initialization. + * @return {nlobjRecord} Returns an nlobjRecord object of a copied record. + * + * @since 2007.0 + */ +function nlapiCopyRecord(type, id, initializeValues) { ; } + +/** + * Load an existing record from the system. + * @governance 10 units for transactions, 2 for custom records, 4 for all other records + * + * @param {string} type The record type name. + * @param {int} id The internal ID for the record. + * @param {Object} initializeValues Contains an array of name/value pairs of defaults to be used during record initialization. + * @return {nlobjRecord} Returns an nlobjRecord object of an existing NetSuite record. + * + * @exception {SSS_INVALID_RECORD_TYPE} + * @exception {SSS_TYPE_ARG_REQD} + * @exception {SSS_INVALID_INTERNAL_ID} + * @exception {SSS_ID_ARG_REQD} + * + * @since 2007.0 + */ +function nlapiLoadRecord(type, id, initializeValues) { ; } + +/** + * Instantiate a new nlobjRecord object containing all the default field data for that record type. + * @governance 10 units for transactions, 2 for custom records, 4 for all other records + * + * @param {string} type record type ID. + * @param {Object} initializeValues Contains an array of name/value pairs of defaults to be used during record initialization. + * @return {nlobjRecord} Returns an nlobjRecord object of a new record from the system. + * + * @exception {SSS_INVALID_RECORD_TYPE} + * @exception {SSS_TYPE_ARG_REQD} + * + * @since 2007.0 + */ +function nlapiCreateRecord(type, initializeValues) { ; } + +/** + * Submit a record to the system for creation or update. + * @governance 20 units for transactions, 4 for custom records, 8 for all other records + * + * @param {nlobjRecord} record nlobjRecord object containing the data record. + * @param {boolean} [doSourcing] If not set, this argument defaults to false. + * @param {boolean} [ignoreMandatoryFields] Disables mandatory field validation for this submit operation. + * @return {string} internal ID for committed record. + * + * @exception {SSS_INVALID_RECORD_OBJ} + * @exception {SSS_RECORD_OBJ_REQD} + * @exception {SSS_INVALID_SOURCE_ARG} + * + * @since 2007.0 + */ +function nlapiSubmitRecord(record, doSourcing, ignoreMandatoryFields) { ; } + +/** + * Delete a record from the system. + * @governance 20 units for transactions, 4 for custom records, 8 for all other records + * + * @param {string} type The record type name. + * @param {int} id The internal ID for the record. + * @return {void} + * + * @exception {SSS_INVALID_RECORD_TYPE} + * @exception {SSS_TYPE_ARG_REQD} + * @exception {SSS_INVALID_INTERNAL_ID} + * @exception {SSS_ID_ARG_REQD} + * + * @since 2007.0 + */ +function nlapiDeleteRecord(type, id) { ; } + +/** + * Perform a record search using an existing search or filters and columns. + * @governance 10 units + * @restriction returns the first 1000 rows in the search + * + * @param {string} type record type ID. + * @param {int, string} [id] The internal ID or script ID for the saved search to use for search. + * @param {nlobjSearchFilter, nlobjSearchFilter[]} [filters] [optional] A single nlobjSearchFilter object - or - an array of nlobjSearchFilter objects. + * @param {nlobjSearchColumn, nlobjSearchColumn[]} [columns] [optional] A single nlobjSearchColumn object - or - an array of nlobjSearchColumn objects. + * @return {nlobjSearchResult[]} Returns an array of nlobjSearchResult objects corresponding to the searched records. + * + * @exception {SSS_INVALID_RECORD_TYPE} + * @exception {SSS_TYPE_ARG_REQD} + * @exception {SSS_INVALID_SRCH_ID} + * @exception {SSS_INVALID_SRCH_FILTER} + * @exception {SSS_INVALID_SRCH_FILTER_JOIN} + * @exception {SSS_INVALID_SRCH_OPERATOR} + * @exception {SSS_INVALID_SRCH_COL_NAME} + * @exception {SSS_INVALID_SRCH_COL_JOIN} + * + * @since 2007.0 + */ +function nlapiSearchRecord(type, id, filters, columns) { ; } + +/** + * Perform a global record search across the system. + * @governance 10 units + * @restriction returns the first 1000 rows in the search + * + * @param {string} keywords Global search keywords string or expression. + * @return {nlobjSearchResult[]} Returns an Array of nlobjSearchResult objects containing the following four columns: name, type (as shown in the UI), info1, and info2. + * + * @since 2008.1 + */ +function nlapiSearchGlobal(keywords) { ; } + +/** + * Perform a duplicate record search using Duplicate Detection criteria. + * @governance 10 units + * @restriction returns the first 1000 rows in the search + * + * @param {string} type The recordType you are checking duplicates for (for example, customer|lead|prospect|partner|vendor|contact). + * @param {string[]} [fields] array of field names used to detect duplicate (for example, companyname|email|name|phone|address1|city|state|zipcode). + * @param {int} [id] internal ID of existing record. Depending on the use case, id may or may not be a required argument. + * @return {nlobjSearchResult[]} Returns an Array of nlobjSearchResult objects corresponding to the duplicate records. + * + * @since 2008.1 + */ +function nlapiSearchDuplicate(type, fields, id) { ; } + +/** + * Create a new record using values from an existing record of a different type. + * @governance 10 units for transactions, 2 for custom records, 4 for all other records + * + * @param {string} type The record type name. + * @param {int} id The internal ID for the record. + * @param {string} transformType The recordType you are transforming the existing record into. + * @param {Object} [transformValues] An object containing transform default option/value pairs used to pre-configure transformed record + * @return {nlobjRecord} + * + * @exception {SSS_INVALID_URL_CATEGORY} + * @exception {SSS_CATEGORY_ARG_REQD} + * @exception {SSS_INVALID_TASK_ID} + * @exception {SSS_TASK_ID_REQD} + * @exception {SSS_INVALID_INTERNAL_ID} + * @exception {SSS_INVALID_EDITMODE_ARG} + * + * @since 2007.0 + */ +function nlapiTransformRecord(type, id, transformType, transformValues) { ; } + +/** + * Fetch the value of one or more fields on a record. This API uses search to look up the fields and is much + * faster than loading the record in order to get the field. + * @governance 10 units for transactions, 2 for custom records, 4 for all other records + * + * @param {string} type The record type name. + * @param {int} id The internal ID for the record. + * @param {string, string[]} fields - field or fields to look up. + * @param {boolean} [text] If set then the display value is returned instead for select fields. + * @return {string, Object} single value or an Object of field name/value pairs depending on the fields argument. + * + * @since 2008.1 + */ +function nlapiLookupField(type,id,fields, text) { ; } + +/** + * Submit the values of a field or set of fields for an existing record. + * @governance 10 units for transactions, 2 for custom records, 4 for all other records + * @restriction only supported for records and fields where DLE (Direct List Editing) is supported + * + * @param {string} type The record type name. + * @param {int} id The internal ID for the record. + * @param {string, string[]} fields field or fields being updated. + * @param {string, string[]} values field value or field values used for updating. + * @param {boolean} [doSourcing] If not set, this argument defaults to false and field sourcing does not occur. + * @return {void} + * + * @since 2008.1 + */ +function nlapiSubmitField(type,id,fields,values,doSourcing) { ; } + +/** + * Attach a single record to another with optional properties. + * @governance 10 units + * + * @param {string} type1 The record type name being attached + * @param {int} id1 The internal ID for the record being attached + * @param {string} type2 The record type name being attached to + * @param {int} id2 The internal ID for the record being attached to + * @param {Object} [properties] Object containing name/value pairs used to configure attach operation + * @return {void} + * + * @since 2008.2 + */ +function nlapiAttachRecord(type1, id1, type2, id2, properties) { ; } + +/** + * Detach a single record from another with optional properties. + * @governance 10 units + * + * @param {string} type1 The record type name being attached + * @param {int} id1 The internal ID for the record being attached + * @param {string} type2 The record type name being attached to + * @param {int} id2 The internal ID for the record being attached to + * @param {Object} [properties] Object containing name/value pairs used to configure detach operation + * @return {void} + * + * @since 2008.2 + */ +function nlapiDetachRecord(type1, id1, type2, id2, properties) { ; } + + +/** + * Resolve a URL to a resource or object in the system. + * + * @param {string} type type specifier for URL: suitelet|tasklink|record|mediaitem + * @param {string} subtype subtype specifier for URL (corresponding to type): scriptid|taskid|recordtype|mediaid + * @param {string} [id] internal ID specifier (sub-subtype corresponding to type): deploymentid|n/a|recordid|n/a + * @param {string} [pagemode] string specifier used to configure page (suitelet: external|internal, tasklink|record: edit|view) + * @return {string} + * + * @since 2007.0 + */ +function nlapiResolveURL(type, subtype, id, pagemode) { ; } + +/** + * Redirect the user to a page. Only valid in the UI on Suitelets and User Events. In Client scripts this will initialize the redirect URL used upon submit. + * + * @param {string} type type specifier for URL: suitelet|tasklink|record|mediaitem + * @param {string} subtype subtype specifier for URL (corresponding to type): scriptid|taskid|recordtype|mediaid + * @param {string} [id] internal ID specifier (sub-subtype corresponding to type): deploymentid|n/a|recordid|n/a + * @param {string} [pagemode] string specifier used to configure page (suitelet: external|internal, tasklink|record: edit|view) + * @param {Object} [parameters] Object used to specify additional URL parameters as name/value pairs + * @return {void} + * + * @since 2007.0 + */ +function nlapiSetRedirectURL(type, subtype, id, pagemode, parameters) { ; } + +/** + * Request a URL to an external or internal resource. + * @restriction NetSuite maintains a white list of CAs that are allowed for https requests. Please see the online documentation for the complete list. + * @governance 10 units + * + * @param {string} url A fully qualified URL to an HTTP(s) resource + * @param {string, Object} [postdata] - string, document, or Object containing POST payload + * @param {Object} [headers] - Object containing request headers. + * @param {function} [callback] - available on the Client to support asynchronous requests. function is passed an nlobjServerResponse with the results. + * @return {nlobjServerResponse} + * + * @exception {SSS_UNKNOWN_HOST} + * @exception {SSS_INVALID_HOST_CERT} + * @exception {SSS_REQUEST_TIME_EXCEEDED} + * + * @since 2007.0 + */ +function nlapiRequestURL(url, postdata, headers, callback, method) { ; } + +/** + * Return context information about the current user/script. + * + * @return {nlobjContext} + * + * @since 2007.0 + */ +function nlapiGetContext() { ; } + +/** + * Return the internal ID for the currently logged in user. Returns -4 when called from online forms or "Available without Login" Suitelets. + * + * @return {int} + * + * @since 2005.0 + */ +function nlapiGetUser() { ; } + +/** + * Return the internal ID for the current user's role. Returns 31 (Online Form User) when called from online forms or "Available without Login" Suitelets. + * + * @return {int} + * + * @since 2005.0 + */ +function nlapiGetRole() { ; } + +/** + * Return the internal ID for the current user's department. + * + * @return {int} + * + * @since 2005.0 + */ +function nlapiGetDepartment() { ; } + +/** + * Return the internal ID for the current user's location. + * + * @return {int} + * + * @since 2005.0 + */ +function nlapiGetLocation() { ; } + +/** + * Return the internal ID for the current user's subsidiary. + * + * @return {int} + * + * @since 2008.1 + */ +function nlapiGetSubsidiary() { ; } + +/** + * Return the recordtype corresponding to the current page or userevent script. + * + * @return {string} + * + * @since 2007.0 + */ +function nlapiGetRecordType() { ; } + +/** + * Return the internal ID corresponding to the current page or userevent script. + * + * @return {int} + * + * @since 2007.0 + */ +function nlapiGetRecordId() { ; } + +/** + * Send out an email and associate it with records in the system. + * Supported base types are entity for entities, transaction for transactions, activity for activities and cases, record|recordtype for custom records + * @governance 10 units + * @restriction all outbound emails subject to email Anti-SPAM policies + * + * @param {int} from internal ID for employee user on behalf of whom this email is sent + * @param {string, int} to email address or internal ID of user that this email is being sent to + * @param {string} subject email subject + * @param {string} body email body + * @param {string, string[]} cc copy email address(es) + * @param {string, string[]} bcc blind copy email address(es) + * @param {Object} records Object of base types -> internal IDs used to associate email to records. i.e. {entity: 100, record: 23, recordtype: customrecord_surveys} + * @param {nlobjFile[]} files array of nlobjFile objects (files) to include as attachments + * @return {void} + * + * @since 2007.0 + */ +function nlapiSendEmail(from, to, subject, body, cc, bcc, records, files) { ; } + +/** + * Sends a single on-demand campaign email to a specified recipient and returns a campaign response ID to track the email. + * @governance 10 units + * @restriction works in conjunction with the Lead Nurturing (campaigndrip) sublist only + * + * @param {int} campaigneventid internal ID of the campaign event + * @param {int} recipientid internal ID of the recipient - the recipient must have an email + * @return {int} + * + * @since 2010.1 + */ +function nlapiSendCampaignEmail(campaigneventid, recipientid) { ; } + +/** + * Send out a fax and associate it with records in the system. This requires fax preferences to be configured. + * Supported base types are entity for entities, transaction for transactions, activity for activities and cases, record|recordtype for custom records + * @governance 10 units + * + * @param {int} from internal ID for employee user on behalf of whom this fax is sent + * @param {string, int} to fax address or internal ID of user that this fax is being sent to + * @param {string} subject fax subject + * @param {string} body fax body + * @param {Object} records Object of base types -> internal IDs used to associate fax to records. i.e. {entity: 100, record: 23, recordtype: customrecord_surveys} + * @param {nlobjFile[]} files array of nlobjFile objects (files) to include as attachments + * @return {void} + * + * @since 2008.2 + */ +function nlapiSendFax(from, to, subject, body, records, files) { ; } + +/** + * Return field definition for a field. + * + * @param {string} fldnam the name of the field + * @return {nlobjField} + * + * @since 2009.1 + */ +function nlapiGetField(fldnam) { ; } + +/** + * Return field definition for a matrix field. + * + * @param {string} type matrix sublist name + * @param {string} fldnam matrix field name + * @param {int} column matrix field column index (1-based) + * @return {nlobjField} + * + * @since 2009.2 + */ +function nlapiGetMatrixField(type, fldnam, column) { ; } + +/** + * Return field definition for a sublist field. + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {int} [linenum] line number for sublist field (1-based) and only valid for sublists of type staticlist and list + * @return {nlobjField} + * + * @since 2009.1 + */ +function nlapiGetLineItemField(type, fldnam, linenum) { ; } + +/** + * Return an nlobjField containing sublist field metadata. + * + * @param {string} type matrix sublist name + * @param {string} fldnam matrix field name + * @param {int} linenum line number (1-based) + * @param {int} column matrix column index (1-based) + * @return {nlobjField} + * + * @since 2009.2 + */ +function nlapiGetLineItemMatrixField(type, fldnam, linenum, column) { ; } + +/** + * Return the value of a field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} fldnam the field name + * @return {string} + * + * @since 2005.0 + */ +function nlapiGetFieldValue(fldnam) { ; } + +/** + * Set the value of a field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @restriction synchronous arg is only supported in client SuiteScript + * + * @param {string} fldnam the field name + * @param {string} value value used to set field + * @param {boolean} [firefieldchanged] if false then the field change event is suppressed (defaults to true) + * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false). + * @return {void} + * + * @since 2005.0 + */ +function nlapiSetFieldValue(fldnam,value,firefieldchanged,synchronous) { ; } + +/** + * Return the display value of a select field's current selection on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} fldnam the field name + * @return {string} + * + * @since 2005.0 + */ +function nlapiGetFieldText(fldnam) { ; } + +/** + * Set the value of a field on the current record on a page using it's label. + * @restriction synchronous arg is only supported in client SuiteScript + * + * @param {string} fldnam the field name + * @param {string} txt display name used to lookup field value + * @param {boolean} [firefieldchanged] if false then the field change event is suppressed (defaults to true) + * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false). + * @return {void} + * + * @since 2005.0 + */ +function nlapiSetFieldText(fldnam,txt,firefieldchanged,synchronous) { ; } + +/** + * Return the values of a multiselect field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} fldnam the field name + * @return {string[]} + * + * @since 2005.0 + */ +function nlapiGetFieldValues(fldnam) { ; } + +/** + * Set the values of a multiselect field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @restriction synchronous arg is only supported in client SuiteScript + * + * @param {string} fldnam field name + * @param {string[]} values array of strings containing values for field + * @param {boolean} [firefieldchanged] if false then the field change event is suppressed (defaults to true) + * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false). + * @return {void} + * + * @since 2005.0 + */ +function nlapiSetFieldValues(fldnam,values,firefieldchanged,synchronous) { ; } + +/** + * Return the values (via display text) of a multiselect field on the current record. + * @restriction supported in client and user event scripts only. + * @param {string} fldnam field name + * @return {string[]} + * + * @since 2009.1 + */ +function nlapiGetFieldTexts(fldnam) { ; } + +/** + * Set the values (via display text) of a multiselect field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @restriction synchronous arg is only supported in client SuiteScript + * + * @param {string} fldnam field name + * @param {string[]} texts array of strings containing display values for field + * @param {boolean} [firefieldchanged] if false then the field change event is suppressed (defaults to true) + * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false). + * @return {void} + * + * @since 2009.1 + */ +function nlapiSetFieldTexts(fldnam,texts,firefieldchanged,synchronous) { ; } + +/** + * Get the value of a matrix header field + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {int} column matrix column index (1-based) + * @return {string} + * + * @since 2009.2 + */ +function nlapiGetMatrixValue(type, fldnam, column) { ; } + +/** + * Set the value of a matrix header field + * @restriction synchronous arg is only supported in client SuiteScript + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {int} column matrix column index (1-based) + * @param {string} value field value for matrix field + * @param {boolean} [firefieldchanged] if false then the field change event is suppressed (defaults to true) + * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false). + * @return {void} + * + * @since 2009.2 + */ +function nlapiSetMatrixValue(type, fldnam, column, value, firefieldchanged, synchronous) { ; } + +/** + * Get the current value of a sublist field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {int} column matrix column index (1-based) + * @return {string} value + * + * @since 2009.2 + */ +function nlapiGetCurrentLineItemMatrixValue(type, fldnam, column) { ; } + +/** + * Set the current value of a sublist field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @restriction synchronous arg is only supported in Client SuiteScript + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {int} column matrix column index (1-based) + * @param {string} value matrix field value + * @param {boolean} [firefieldchanged] if false then the field change event is suppressed (defaults to true) + * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false). + * @return {void} + * + * @since 2009.2 + */ +function nlapiSetCurrentLineItemMatrixValue(type, fldnam, column, value, firefieldchanged, synchronous) { ; } + +/** + * Return the value of a sublist matrix field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {int} linenum line number (1-based) + * @param {int} column column index (1-based) + * @param {string} value + * + * @since 2009.2 + */ +function nlapiGetLineItemMatrixValue(type, fldnam, linenum, column) { ; } + +/** + * Return the value of a sublist field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {int} linenum line number (1-based) + * @return {string} + * + * @since 2005.0 + */ +function nlapiGetLineItemValue(type,fldnam,linenum) { ; } + +/** + * Set the value of a sublist field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {int} linenum line number (1-based) + * @param {string} value + * @retun {void} + * + * @since 2005.0 + */ +function nlapiSetLineItemValue(type,fldnam,linenum,value) { ; } + +/** + * Return the label of a select field's current selection for a particular line. + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {int} linenum line number (1-based) + * @return {string} + * + * @since 2005.0 + */ +function nlapiGetLineItemText(type,fldnam,linenum) { ; } + +/** + * Return the 1st line number that a sublist field value appears in + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {string} val the value being queried for in a sublist field + * @return {int} + * + * @since 2009.2 + */ +function nlapiFindLineItemValue(type, fldnam, val) { ; } + +/** + * Return the 1st line number that a matrix field value appears in + * + * @param {string} type sublist name + * @param {string} fldnam matrix field name + * @param {int} column matrix column index (1-based) + * @param {string} val the value being queried for in a matrix field + * @return {int} + * + * @since 2009.2 + */ +function nlapiFindLineItemMatrixValue(type, fldnam, column, val) { ; } + +/** + * Return the number of columns for a matrix field + * + * @param {string} type sublist name + * @param {string} fldnam matrix field name + * @return {int} + * + * @since 2009.2 + */ +function nlapiGetMatrixCount(type, fldnam) { ; } + +/** + * Return the number of sublists in a sublist on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} type sublist name + * @return {int} + * + * @since 2005.0 + */ +function nlapiGetLineItemCount(type) { ; } + +/** + * Insert and select a new line into the sublist on a page or userevent. + * + * @param {string} type sublist name + * @param {int} [line] line number at which to insert a new line. + * @return{void} + * + * @since 2005.0 + */ +function nlapiInsertLineItem(type, line) { ; } + +/** + * Remove the currently selected line from the sublist on a page or userevent. + * + * @param {string} type sublist name + * @param {int} [line] line number to remove. + * @return {void} + * + * @since 2005.0 + */ +function nlapiRemoveLineItem(type, line) { ; } + +/** + * Set the value of a field on the currently selected line. + * @restriction synchronous arg is only supported in client SuiteScript + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {string} value field value + * @param {boolean} [firefieldchanged] if false then the field change event is suppressed (defaults to true) + * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false). + * @return {void} + * + * @since 2005.0 + */ +function nlapiSetCurrentLineItemValue(type,fldnam,value,firefieldchanged,synchronous) { ; } + +/** + * Set the value of a field on the currently selected line using it's label. + * @restriction synchronous arg is only supported in client SuiteScript + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {string} txt string containing display value or search text. + * @param {boolean} [firefieldchanged] if false then the field change event is suppressed (defaults to true) + * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false). + * @return {void} + * + * @since 2005.0 + */ +function nlapiSetCurrentLineItemText(type,fldnam,txt,firefieldchanged,synchronous) { ; } + +/** + * Return the value of a field on the currently selected line. + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @return {string} + * + * @since 2005.0 + */ +function nlapiGetCurrentLineItemValue(type,fldnam) { ; } + +/** + * Return the label of a select field's current selection on the currently selected line. + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @return {string} + * + * @since 2005.0 + */ +function nlapiGetCurrentLineItemText(type,fldnam) { ; } + +/** + * Return the line number for the currently selected line. + * + * @param {string} type sublist name + * @return {int} + * + * @since 2005.0 + */ +function nlapiGetCurrentLineItemIndex(type) { ; } + +/** + * Disable a sublist field. + * @restriction Only supported on sublists of type inlineeditor, editor and list (current field only) + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {boolean} disable if true then field is disabled + * @param {int} linenum line number for sublist field (1-based) and only valid for sublists of type list + * @return {void} + * + * @since 2009.1 + */ +function nlapiSetLineItemDisabled(type,fldnam,disable, linenum) { ; } + +/** + * Return field mandatoriness. + * + * @param {string} fldnam field name + * @return {boolean} + * + * @since 2009.1 + */ +function nlapiGetFieldMandatory(fldnam) { ; } + +/** + * Return sublist field mandatoriness. + * @restriction Only supported on sublists of type inlineeditor or editor (current field only) + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @return {boolean} + * + * @since 2009.1 + */ +function nlapiGetLineItemMandatory(type,fldnam) { ; } + +/** + * Make a field mandatory. + * + * @param {string} fldnam field name + * @param {boolean} mandatory if true then field is made mandatory + * @return {void} + * + * @since 2009.1 + */ +function nlapiSetFieldMandatory(fldnam,mandatory) { ; } + +/** + * Make a sublist field mandatory. + * @restriction Only supported on sublists of type inlineeditor or editor (current field only) + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {boolean} mandatory if true then field is made mandatory + * @return {void} + * + * @since 2009.2 + */ +function nlapiSetLineItemMandatory(type,fldnam,mandatory) { ; } + +/** + * Select an existing line in a sublist. + * + * @param {string} type sublist name + * @param {int} linenum line number to select + * @return {void} + * + * @since 2005.0 + */ +function nlapiSelectLineItem(type, linenum) { ; } + +/** + * Save changes made on the currently selected line to the sublist. + * + * @param {string} type sublist name + * @return {void} + * + * @since 2005.0 + */ +function nlapiCommitLineItem(type) { ; } + +/** + * Cancel any changes made on the currently selected line. + * @restriction Only supported for sublists of type inlineeditor and editor + * + * @param {string} type sublist name + * @return {void} + * + * @since 2005.0 + */ +function nlapiCancelLineItem(type) { ; } + +/** + * Select a new line in a sublist. + * @restriction Only supported for sublists of type inlineeditor and editor + * + * @param {string} type sublist name + * @return {void} + * + * @since 2005.0 + */ +function nlapiSelectNewLineItem(type) { ; } + +/** + * Refresh the sublist table. + * @restriction Only supported for sublists of type inlineeditor, editor, and staticlist + * @restriction Client SuiteScript only. + * + * @param {string} type sublist name + * @return{void} + * + * @since 2005.0 + */ +function nlapiRefreshLineItems(type) { ; } + +/** + * Adds a select option to a scripted select or multiselect field. + * @restriction Client SuiteScript only + * + * @param {string} fldnam field name + * @param {string} value internal ID for select option + * @param {string} text display text for select option + * @param {boolean} [selected] if true then option will be selected by default + * @return {void} + * + * @since 2008.2 + */ +function nlapiInsertSelectOption(fldnam, value, text, selected) { ; } + +/** + * Removes a select option (or all if value is null) from a scripted select or multiselect field. + * @restriction Client SuiteScript only + * + * @param {string} fldnam field name + * @param {string} value internal ID of select option to remove + * @return {void} + * + * @since 2008.2 + */ +function nlapiRemoveSelectOption(fldnam, value) { ; } + +/** + * Adds a select option to a scripted select or multiselect sublist field. + * @restriction Client SuiteScript only + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {string} value internal ID for select option + * @param {string} text display text for select option + * @param {boolean} [selected] if true then option will be selected by default + * @return {void} + * + * @since 2008.2 + */ +function nlapiInsertLineItemOption(type, fldnam, value, text, selected) { ; } + +/** + * Removes a select option (or all if value is null) from a scripted select or multiselect sublist field. + * @restriction Client SuiteScript only + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {string} value internal ID for select option to remove + * @return {void} + * + * @since 2008.2 + */ +function nlapiRemoveLineItemOption(type, fldnam, value) { ; } + +/** + * Returns true if any changes have been made to a sublist. + * @restriction Client SuiteScript only + * + * @param {string} type sublist name + * @return {boolean} + * + * @since 2005.0 + */ +function nlapiIsLineItemChanged(type) { ; } + +/** + * Return an record object containing the data being submitted to the system for the currenr record. + * @restriction User Event scripts only + * + * @return {nlobjRecord} + * + * @since 2008.1 + */ +function nlapiGetNewRecord() { ; } + +/** + * Return an record object containing the current record's data prior to the write operation. + * @restriction beforeSubmit|afterSubmit User Event scripts only + * + * @return {nlobjRecord} + * + * @since 2008.1 + */ +function nlapiGetOldRecord() { ; } + +/** + * Create an nlobjError object that can be used to abort script execution and configure error notification + * + * @param {string} code error code + * @param {string} details error description + * @param {boolean} [suppressEmail] if true then suppress the error notification emails from being sent out (false by default). + * @return {nlobjError} + * + * @since 2008.2 + */ +function nlapiCreateError(code,details,suppressEmail) { ; } + +/** + * Return a new entry form page. + * @restriction Suitelets only + * + * @param {string} title page title + * @param {boolean} [hideHeader] true to hide the page header (false by default) + * @return {nlobjForm} + * + * @since 2008.2 + */ +function nlapiCreateForm(title, hideHeader) { ; } + +/** + * Return a new list page. + * @restriction Suitelets only + * + * @param {string} title page title + * @param {boolean} [hideHeader] true to hide the page header (false by default) + * @return {nlobjList} + * + * @since 2008.2 + */ +function nlapiCreateList(title, hideHeader) { ; } + +/** + * Return a new assistant page. + * @restriction Suitelets only + * + * @param {string} title page title + * @param {boolean} [hideHeader] true to hide the page header (false by default) + * @return {nlobjAssistant} + * + * @since 2009.2 + */ +function nlapiCreateAssistant(title, hideHeader) { ; } + +/** + * Load a file from the file cabinet (via its internal ID or path). + * @governance 10 units + * @restriction Server SuiteScript only + * + * @param {string, int} id internal ID or relative path to file in the file cabinet (i.e. /SuiteScript/foo.js) + * @return {nlobjFile} + * + * @since 2008.2 + */ +function nlapiLoadFile(id) { ; } + +/** + * Add/update a file in the file cabinet. + * @governance 20 units + * @restriction Server SuiteScript only + * + * @param {nlobjFile} file a file object to submit + * @return {int} return internal ID of file + * + * @since 2009.1 + */ +function nlapiSubmitFile(file) { ; } + +/** + * Delete a file from the file cabinet. + * @governance 20 units + * @restriction Server SuiteScript only + * + * @param {int} id internal ID of file to be deleted + * @return {id} + * + * @since 2009.1 + */ +function nlapiDeleteFile(id) { ; } + +/** + * Instantiate a file object (specifying the name, type, and contents which are base-64 encoded for binary types.) + * @restriction Server SuiteScript only + * + * @param {string} name file name + * @param {string} type file type i.e. plainText, htmlDoc, pdf, word (see documentation for the list of supported file types) + * @param {string} contents string containing file contents (must be base-64 encoded for binary types) + * @return {nlobjFile} + * + * @since 2009.1 + */ +function nlapiCreateFile(name, type, contents) { ; } + +/** + * Perform a mail merge operation using any template and up to 2 records and returns an nlobjFile with the results. + * @restriction only supported for record types that are available in mail merge: transactions, entities, custom records, and cases + * @restriction Server SuiteScript only + * @governance 10 units + * + * @param {int} id internal ID of template + * @param {string} baseType primary record type + * @param {int} baseId internal ID of primary record + * @param {string} [altType] secondary record type + * @param {int} [altId] internal ID of secondary record + * @param {Object} [fields] Object of merge field values to use in the mail merge (by default all field values are obtained from records) which overrides those from the record. + * @return {nlobjFile} + * + * @since 2008.2 + */ +function nlapiMergeRecord(id, baseType, baseId, altType, altId, fields) { ; } + +/** + * Print a record (transaction) gievn its type, id, and output format. + * @restriction Server SuiteScript only + * @governance 10 units + * + * @param {string} type print output type: transaction|statement|packingslip|pickingticket + * @param {int} id internal ID of record to print + * @param {string} [format] output format: html|pdf|default + * @param {Object} [properties] Object of properties used to configure print + * @return {nlobjFile} + * + * @since 2008.2 + */ +function nlapiPrintRecord(type, id, format, properties) { ; } + +/** + * Generate a PDF from XML using the BFO report writer (see http://big.faceless.org/products/report/). + * @restriction Server SuiteScript only + * @governance 10 units + * + * @param {string} input string containing BFO compliant XHTML + * @return {nlobjFile} + * + * @since 2009.1 + */ +function nlapiXMLToPDF(input) { ; } + +/** + * Create an entry in the script execution log (note that execution log entries are automatically purged after 30 days). + * + * @param {string} type log type: debug|audit|error|emergency + * @param {string} title log title (up to 90 characters supported) + * @param {string} [details] log details (up to 3000 characters supported) + * @return {void} + * + * @since 2008.1 + */ +function nlapiLogExecution(type, title, details) { ; } + +/** + * Queue a scheduled script for immediate execution and return the status QUEUED if successfull. + * @restriction Server SuiteScript only + * @governance 20 units + * + * @param {string, int} script script ID or internal ID of scheduled script + * @param {string, int} [deployment] script ID or internal ID of scheduled script deployment. If empty, the first "free" deployment (i.e. status = Not Scheduled or Completed) will be used + * @param {Object} parameters Object of parameter name->values used in this scheduled script instance + * @return {string} QUEUED or null if no available deployments were found or the current status of the deployment specified if it was not available. + * + * @since 2008.1 + */ +function nlapiScheduleScript(script, deployment, parameters) { ; } + +/** + * Return a URL with a generated OAuth token. + * @restriction Suitelets and Portlets only + * @governance 20 units + * + * @param {string} ssoAppKey + * @return {string} + * + * @since 2009.2 + */ +function nlapiOutboundSSO(ssoAppKey) { ; } + +/** + * Loads a configuration record + * @restriction Server SuiteScript only + * @governance 10 units + * + * @param {string} type + * @return {nlobjConfiguration} + * + * @since 2009.2 + */ +function nlapiLoadConfiguration(type) { ; } + +/** + * Commits all changes to a configuration record. + * @restriction Server SuiteScript only + * @governance 10 units + * + * @param {nlobjConfiguration} setup record + * @return (void) + * + * @since 2009.2 + */ +function nlapiSubmitConfiguration(setup) { ; } + +/** + * Convert a String into a Date object. + * + * @param {string} str date string in the user's date format, timeofday format, or datetime format + * @param {string} format format type to use: date|datetime|timeofday with date being the default + * @return {date} + * + * @since 2005.0 + */ +function nlapiStringToDate(str, format) { ; } + +/** + * Convert a Date object into a String + * + * @param {date} d date object being converted to a string + * @param {string} [formattype] format type to use: date|datetime|timeofday with date being the default + * @return {string} + * + * @since 2005.0 + */ +function nlapiDateToString(d, formattype) { ; } + +/** + * Add days to a Date object and returns a new Date + * + * @param {date} d date object used to calculate the new date + * @param {int} days the number of days to add to this date object. + * @return {date} + * + * @since 2008.1 + */ +function nlapiAddDays(d, days) { ; } + +/** + * Add months to a Date object and returns a new Date. + * + * @param {date} d date object used to calculate the new date + * @param {int} months the number of months to add to this date object. + * @return {date} + * + * @since 2008.1 + */ +function nlapiAddMonths(d, months) { ; } + +/** + * Format a number for data entry into a currency field. + * + * @param {string} str numeric string used to format for display as currency using user's locale + * @return {string} + * + * @since 2008.1 + */ +function nlapiFormatCurrency(str) { ; } + +/** + * Encrypt a String using a SHA-1 hash function + * + * @param {string} s string to encrypt + * @return {string} + * + * @since 2009.2 + */ +function nlapiEncrypt(s) { ; } + +/** + * Escape a String for use in an XML document. + * + * @param {string} text string to escape + * @return {string} + * + * @since 2008.1 + */ +function nlapiEscapeXML(text) { ; } + +/** + * Convert a String into an XML document. Note that in Server SuiteScript XML is supported natively by the JS runtime using the e4x standard (http://en.wikipedia.org/wiki/E4X) + * This makes scripting XML simpler and more efficient + * + * @param {string} str string being parsed into an XML document + * @return {document} + * + * @since 2008.1 + */ +function nlapiStringToXML(str) { ; } + +/** + * Convert an XML document into a String. Note that in Server SuiteScript XML is supported natively by the JS runtime using the e4x standard (http://en.wikipedia.org/wiki/E4X) + * This makes scripting XML data simpler and more efficient + * + * @param {document} xml document being serialized into a string + * @return {string} + * + * @since 2008.1 + */ +function nlapiXMLToString(xml) { ; } + +/** + * select a value from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix) + * + * @param {node} node node being queried + * @param {string} xpath string containing XPath expression. + * @return {string} + * + * @since 2008.2 + */ +function nlapiSelectValue(node, xpath) { ; } + +/** + * Select an array of values from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix) + * + * @param {node} node node being queried + * @param {string} xpath string containing XPath expression. + * @return {string[]} + * + * @since 2008.1 + */ +function nlapiSelectValues(node, xpath) { ; } + +/** + * Select a node from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix) + * + * @param {node} node node being queried + * @param {string} xpath string containing XPath expression. + * @return {node} + * + * @since 2008.1 + */ +function nlapiSelectNode(node, xpath) { ; } + +/** + * Select an array of nodes from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix) + * + * @param {node} node node being queried + * @param {string} xpath string containing XPath expression. + * @return {node[]} + * + * @since 2008.1 + */ +function nlapiSelectNodes(node, xpath) { ; } + +/** + * Calculate exchange rate between two currencies as of today or an optional effective date. + * @governance 10 units + * + * @param {string, int} fromCurrency internal ID or currency code of currency we are converting from + * @param {string, int} toCurrency internal ID or currency code of currency we are converting to + * @param {string} [date] string containing date of effective exchange rate. defaults to today + * @return {float} + * + * @since 2009.1 + */ +function nlapiExchangeRate(fromCurrency, toCurrency, date) { ; } + +/** + * Initiates a workflow on-demand and returns the workflow instance ID for the workflow-record combination. + * @governance 20 units + * + * @param {string} recordtype record type ID of the workflow base record + * @param {int} id internal ID of the base record + * @param {string, int} workflowid internal ID or script ID for the workflow definition + * @return {int} + * + * @since 2010.1 + */ +function nlapiInitiateWorkflow(recordtype, id, workflowid) { ; } + +/** + * Triggers a workflow on a record. + * @governance 20 units + * + * @param {string} recordtype record type ID of the workflow base record + * @param {int} id internal ID of the base record + * @param {string, int} workflowid internal ID or script ID for the workflow definition + * @param {string, int} actionid internal ID or script ID of the action script + * @return {int} + * + * @since 2010.1 + */ +function nlapiTriggerWorkflow(recordtype, id, workflowid, actionid) { ; } + +/** + * Create a subrecord on a sublist field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @retun {nlobjSubrecord} + * + * @since 2011.2 + */ +function nlapiCreateCurrentLineSubrecord(type,fldnam) { ; } + +/** + * edit a subrecord on a sublist field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @retun {nlobjSubrecord} + * + * @since 2011.2 + */ +function nlapiEditCurrentLineItemSubrecord(type,fldnam) { ; } + +/** + * remove a subrecord on a sublist field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @retun {void} + * + * @since 2011.2 + */ +function nlapiRemoveCurrentLineItemSubrecord(type,fldnam) { ; } + + +/** + * view a subrecord on a sublist field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @retun {nlobjSubrecord} + * + * @since 2011.2 + */ +function nlapiViewCurrentLineItemSubrecord(type,fldnam) { ; } + + +/** + * view a subrecord on a sublist field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @retun {nlobjSubrecord} + * + * @since 2011.2 + */ +function nlapiViewLineItemSubrecord(type,fldnam,linenum) { ; } + +/** + * create a subrecord on body field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} fldnam body field name + * @retun {nlobjSubrecord} + * + * @since 2011.2 + */ +function createSubrecord(fldnam) { ; } + +/** + * edit a subrecord on body field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} fldnam body field name + * @retun {nlobjSubrecord} + * + * @since 2011.2 + */ +function editSubrecord(fldnam) { ; } + +/** + * remove a subrecord on body field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} fldnam body field name + * @retun {void} + * + * @since 2011.2 + */ +function removeSubrecord(fldnam) { ; } + +/** + * view a subrecord on body field on the current record on a page. + * @restriction supported in client and user event scripts only. + * @param {string} fldnam body field name + * @retun {nlobjSubrecord} + * + * @since 2011.2 + */ +function viewSubrecord(fldnam) { ; } + + +/** + * Commit the subrecord after you finish modifying it. + * + * @return {void} + * + * @method + * @memberOf nlobjSubrecord + * + * @since 2008.1 + */ +nlobjSubrecord.prototype.commit = function() { ; } + +/** + * Cancel the any modification on subrecord. + * + * @return {void} + * + * @method + * @memberOf nlobjSubrecord + * + * @since 2008.1 + */ +nlobjSubrecord.prototype.cancel = function() { ; } + +/** + * Return a new instance of nlobjRecord used for accessing and manipulating record objects. + * + * @classDescription Class definition for business records in the system. + * @return {nlobjRecord} + * @constructor + * + * @since 2008.2 + */ +function nlobjRecord() { ; } + +/** + * Return the internalId of the record or NULL for new records. + * + * @return {int} Return the integer value of the record ID. + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.1 + */ +nlobjRecord.prototype.getId = function() { ; } + +/** + * Return the recordType corresponding to this record. + * + * @return {string} The string value of the record name internal ID + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.1 + */ +nlobjRecord.prototype.getRecordType = function( ) { ; } + +/** + * Return field metadata for field. + * + * @param {string} fldnam field name + * @return {nlobjField} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.1 + */ +nlobjRecord.prototype.getField = function(fldnam) { ; } + +/** + * Return sublist metadata for sublist. + * + * @param {string} type sublist name + * @return {nlobjSubList} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.getSubList = function(type) { ; } + +/** + * Return field metadata for field. + * + * @param {string} type matrix sublist name + * @param {string} fldnam matrix field name + * @param {column} linenum matrix column (1-based) + * @return {nlobjField} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.getMatrixField = function(type, fldnam, column) { ; } + +/** + * Return metadata for sublist field. + * + * @param {string} type sublist name + * @param {string} fldnam sublist field name + * @param {int} [linenum] line number (1-based). If empty, the current sublist field is returned. only settable for sublists of type list + * @return {nlobjField} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.getLineItemField = function(type, fldnam, linenum) { ; } + +/** + * Return metadata for sublist field. + * + * @param {string} type matrix sublist name + * @param {string} fldnam matrix field name + * @param {int} linenum line number + * @param {column} linenum matrix column (1-based) + * @return {nlobjField} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.getLineItemMatrixField = function(type, fldnam, linenum, column) { ; } + +/** + * Set the value of a field. + * + * @param {string} name field name + * @param {string} value field value + * @return {void} + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.1 + */ +nlobjRecord.prototype.setFieldValue = function( name, value ) { ; } + +/** + * Set the values of a multi-select field. + * + * @param {string} name field name + * @param {string[]} values string array containing field values + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.1 + */ +nlobjRecord.prototype.setFieldValues = function( name, values ) { ; } + +/** + * Return the value of a field. + * + * @param {string} name field name + * @return {string} + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.1 + */ +nlobjRecord.prototype.getFieldValue = function( name ) { ; } + +/** + * Return the selected values of a multi-select field as an Array. + * + * @param {string} name field name + * @return {string[]} + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.1 + */ +nlobjRecord.prototype.getFieldValues = function( name ) { ; } + +/** + * Set the value (via display value) of a select field. + * @restriction only supported for select fields + * + * @param {string} name field name + * @param {string} text field display value + * @return {void} + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.2 + */ +nlobjRecord.prototype.setFieldText = function( name, text ) { ; } + +/** + * Set the values (via display values) of a multi-select field. + * @restriction only supported for multi-select fields + * + * @param {string} name field name + * @param {string[]} texts array of field display values + * @return {void} + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.2 + */ +nlobjRecord.prototype.setFieldTexts = function( name, texts ) { ; } + +/** + * Return the display value for a select field. + * @restriction only supported for select fields + * + * @param {string} name field name + * @return {string} + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.2 + */ +nlobjRecord.prototype.getFieldText = function( name ) { ; } + +/** + * Return the selected display values of a multi-select field as an Array. + * @restriction only supported for multi-select fields + * + * @param {string} name field name + * @return {string[]} + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.2 + */ +nlobjRecord.prototype.getFieldTexts = function( name ) { ; } + +/** + * Get the value of a matrix header field. + * + * @param {string} type matrix sublist name + * @param {string} name matrix field name + * @param {int} column matrix column index (1-based) + * @return {string} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.getMatrixValue = function( type, name, column ) { ; } + +/** + * Set the value of a matrix header field. + * + * @param {string} type matrix sublist name + * @param {string} name matrix field name + * @param {int} column matrix column index (1-based) + * @param {string} value field value + * @return {void} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.setMatrixValue = function( type, name, column, value ) { ; } + +/** + * Return an Array of all field names on the record. + * + * @return {string[]} + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.1 + */ +nlobjRecord.prototype.getAllFields = function( ) { ; } + +/** + * Return an Array of all field names on a record for a particular sublist. + * + * @param {string} group sublist name + * @return {string[]} + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.2 + */ +nlobjRecord.prototype.getAllLineItemFields = function( group ) { ; } + +/** + * Set the value of a sublist field. + * + * @param {string} group sublist name + * @param {string} name sublist field name + * @param {int} line line number (1-based) + * @param {string} value sublist field value + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.1 + */ +nlobjRecord.prototype.setLineItemValue = function( group, name, line, value ) { ; } + +/** + * Return the value of a sublist field. + * + * @param {string} group sublist name + * @param {string} name sublist field name + * @param {int} line line number (1-based) + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.1 + */ +nlobjRecord.prototype.getLineItemValue = function( group, name, line ) { ; } + +/** + * Return the text value of a sublist field. + * + * @param {string} group sublist name + * @param {string} name sublist field name + * @param {int} line line number (1-based) + * @return {string} + * + * @method + * @memberOf nlobjRecord + * + * @since 2008.2 + */ +nlobjRecord.prototype.getLineItemText = function( group, name, line ) { ; } + +/** + * Set the current value of a sublist field. + * @param {string} group sublist name + * @param {string} name sublist field name + * @param {string} value sublist field value + * @return {void} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.setCurrentLineItemValue = function( group, name, value ) { ; } + +/** + * Return the current value of a sublist field. + * + * @param {string} group sublist name + * @param {string} name sublist field name + * @return {string} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.getCurrentLineItemValue = function( group, name ) { ; } + +/** + * Return the current display value of a sublist field. + * + * @param {string} group sublist name + * @param {string} name sublist field name + * @return {string} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.getCurrentLineItemText = function( group, name ) { ; } + +/** + * Set the current value of a sublist matrix field. + * + * @param {string} group matrix sublist name + * @param {string} name matrix field name + * @param {int} column matrix field column index (1-based) + * @param {string} value matrix field value + * @return {void} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.setCurrentLineItemMatrixValue = function( group, name, column, value ) { ; } + +/** + * Return the current value of a sublist matrix field. + * + * @param {string} group matrix sublist name + * @param {string} name matrix field name + * @param {int} column matrix field column index (1-based) + * @return {string} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.getCurrentLineItemMatrixValue = function( group, name, column ) { ; } + +/** + * Return the number of columns for a matrix field. + * + * @param {string} group matrix sublist name + * @param {string} name matrix field name + * @return {int} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.getMatrixCount = function( group, name ) { ; } + +/** + * Return the number of lines in a sublist. + * + * @param {string} group sublist name + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.getLineItemCount = function( group ) { ; } + +/** + * Return line number for 1st occurence of field value in a sublist column. + * + * @param {string} group sublist name + * @param {string} fldnam sublist field name + * @param {string} value sublist field value + * @return {int} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.findLineItemValue = function( group, fldnam, value ) { ; } + +/** + * Return line number for 1st occurence of field value in a sublist column. + * + * @param {string} group sublist name + * @param {string} fldnam sublist field name + * @param {int} column matrix column index (1-based) + * @param {string} value matrix field value + * @return {int} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.findLineItemMatrixValue = function( group, fldnam, column, value ) { ; } + +/** + * Insert a new line into a sublist. + * + * @param {string} group sublist name + * @param {int} [line] line index at which to insert line + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.insertLineItem = function( group, line ) { ; } + +/** + * Remove an existing line from a sublist. + * + * @param {string} group sublist name + * @param {int} [line] line number to remove + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.removeLineItem = function( group, line ) { ; } + +/** + * Insert and select a new line in a sublist. + * + * @param {string} group sublist name + * @return {void} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.selectNewLineItem = function( group ) { ; } + +/** + * Select an existing line in a sublist. + * + * @param {string} group sublist name + * @param {int} line line number to select + * @return {void} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.selectLineItem = function( group, line ) { ; } + +/** + * Commit the current line in a sublist. + * + * @param {string} group sublist name + * @return {void} + * + * @method + * @memberOf nlobjRecord + * + * @since 2009.2 + */ +nlobjRecord.prototype.commitLineItem = function( group ) { ; } + +/** + * Return a new instance of nlobjConfiguration.. + * + * @classDescription Class definition for interacting with setup/configuration pages + * @return {nlobjConfiguration} + * @constructor + * + * @since 2009.2 + */ +function nlobjConfiguration( ) { ; } + +/** + * return the type corresponding to this setup record. + * + * @return {string} + * + * @method + * @memberOf nlobjConfiguration + * + * @since 2009.2 + */ +nlobjConfiguration.prototype.getType = function( ) { ; } + +/** + * return field metadata for field. + * + * @param {string} fldnam field name + * @return {nlobjField} + * + * @method + * @memberOf nlobjConfiguration + * + * @since 2009.2 + */ +nlobjConfiguration.prototype.getField = function(fldnam) { ; } + +/** + * set the value of a field. + * + * @param {string} name field name + * @param {string} value field value + * @return {void} + * + * @method + * @memberOf nlobjConfiguration + * + * @since 2009.2 + */ +nlobjConfiguration.prototype.setFieldValue = function( name, value ) { ; } + +/** + * Set the values of a multi-select field. + * @restriction only supported for multi-select fields + * + * @param {string} name field name + * @param {string[]} value field values + * @return {void} + * + * @method + * @memberOf nlobjConfiguration + * + * @since 2009.2 + */ +nlobjConfiguration.prototype.setFieldValues = function( name, value ) { ; } + +/** + * return the value of a field. + * + * @param {string} name field name + * @return {string} + * + * @method + * @memberOf nlobjConfiguration + * + * @since 2009.2 + */ +nlobjConfiguration.prototype.getFieldValue = function( name ) { ; } + +/** + * return the selected values of a multi-select field as an Array. + * @restriction only supported for multi-select fields + * + * @param {string} name field name + * @return {string[]} + * + * @method + * @memberOf nlobjConfiguration + * + * @since 2009.2 + */ +nlobjConfiguration.prototype.getFieldValues = function( name ) { ; } + +/** + * set the value (via display value) of a field. + * @restriction only supported for select fields + * + * @param {string} name field name + * @param {string} text field display text + * @return {void} + * + * @method + * @memberOf nlobjConfiguration + * + * @since 2009.2 + */ +nlobjConfiguration.prototype.setFieldText = function( name, text ) { ; } + +/** + * set the values (via display values) of a multi-select field. + * @restriction only supported for multi-select fields + * + * @param {string} name field name + * @param {string[]} texts array of field display text values + * @return {void} + * + * @method + * @memberOf nlobjConfiguration + * + * @since 2009.2 + */ +nlobjConfiguration.prototype.setFieldTexts = function( name, texts ) { ; } + +/** + * return the text value of a field. + * @restriction only supported for select fields + * + * @param {string} name field name + * @return {string} + * + * @method + * @memberOf nlobjConfiguration + * + * @since 2009.2 + */ +nlobjConfiguration.prototype.getFieldText = function( name ) { ; } + +/** + * return the selected text values of a multi-select field as an Array. + * @param {string} name field name + * @return {string[]} + * + * @method + * @memberOf nlobjConfiguration + * + * @since 2009.2 + */ +nlobjConfiguration.prototype.getFieldTexts = function( name ) { ; } + +/** + * return an Array of all field names on the record. + * @return {string[]} + * + * @method + * @memberOf nlobjConfiguration + * + * @since 2009.2 + */ +nlobjConfiguration.prototype.getAllFields = function( ) { ; } + +/** + * 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 + */ +function nlobjFile( ) { ; } + +/** + * Return the name of the file. + * @return {string} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.getName = function( ) { ; } + +/** + * Sets the name of a file. + * @param {string} name the name of the file + * @return {void} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.setName = function( name ) { ; } + +/** + * return the internal ID of the folder that this file is in. + * @return {int} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.getFolder = function( ) { ; } + +/** + * sets the internal ID of the folder that this file is in. + * @param {int} folder + * @return {void} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.setFolder = function( folder ) { ; } + +/** + * sets the character encoding for the file. + * @param {String} encoding + * @return {void} + * + * @method + * @memberOf nlobjFile + * + * @since 2010.2 + */ +nlobjFile.prototype.setEncoding = function( encoding ) { ; } + +/** + * return true if the file is "Available without Login". + * @return {boolean} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.isOnline = function( ) { ; } + +/** + * sets the file's "Available without Login" status. + * @param {boolean} online + * @return {void} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.setIsOnline = function( online ) { ; } + +/** + * return true if the file is inactive. + * @return {boolean} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.isInactive = function( ) { ; } + +/** + * sets the file's inactive status. + * @param {boolean} inactive + * @return {void} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.setIsInactive = function( inactive ) { ; } + +/** + * return the file description. + * @return {string} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.getDescription = function( ) { ; } + +/** + * sets the file's description. + * @param {string} descr the file description + * @return {void} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.setDescription = function( descr ) { ; } + +/** + * Return the id of the file (if stored in the FC). + * @return {int} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.getId = function( ) { ; } + +/** + * Return the size of the file in bytes. + * @return {int} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.getSize = function( ) { ; } + +/** + * Return the URL of the file (if stored in the FC). + * @return {string} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.getURL = function( ) { ; } + +/** + * Return the type of the file. + * @return {string} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.getType = function( ) { ; } + +/** + * Return the value (base64 encoded for binary types) of the file. + * @return {string} + * + * @method + * @memberOf nlobjFile + * + * @since 2009.1 + */ +nlobjFile.prototype.getValue = function( ) { ; } + +/** + * Return a new instance of nlobjSearchFilter filter objects used to define search criteria. + * + * @classDescription search filter + * @constructor + * @param {string} name filter name. + * @param {string} join internal ID for joined search where this filter is defined + * @param {string} operator operator name (i.e. anyOf, contains, lessThan, etc..) + * @param {string|string[]} value + * @param {string} value2 + * @return {nlobjSearchFilter} + * + * @since 2007.0 + */ +function nlobjSearchFilter( name, join, operator, value, value2 ) { ; } + +/** + * Return the name of this search filter. + * @return {string} + * + * @method + * @memberOf nlobjSearchFilter + * + * @since 2007.0 + */ +nlobjSearchFilter.prototype.getName = function( ) { ; } + +/** + * Return the join id for this search filter. + * @return {string} + * + * @method + * @memberOf nlobjSearchFilter + * + * @since 2008.1 + */ +nlobjSearchFilter.prototype.getJoin = function( ) { ; } + +/** + * Return the filter operator used. + * @return {string} + * + * @method + * @memberOf nlobjSearchFilter + * + * @since 2008.2 + */ +nlobjSearchFilter.prototype.getOperator = function( ) { ; } + +/** + * Return a new instance of nlobjSearchColumn used for column objects used to define search return columns. + * + * @classDescription search column. + * @return {nlobjSearchColumn} + * @constructor + * @param {string} name column name. + * @param {string} join internal ID for joined search where this column is defined + * @param {string} summary + * + * @since 2007.0 + */ +function nlobjSearchColumn( name, join, summary ) { ; } + +/** + * return the name of this search column. + * @return {string} + * + * @method + * @memberOf nlobjSearchColumn + * @since 2008.1 + */ +nlobjSearchColumn.prototype.getName = function( ) { ; } + +/** + * return the join id for this search column. + * @return {string} + * + * @method + * @memberOf nlobjSearchColumn + * @since 2008.1 + */ +nlobjSearchColumn.prototype.getJoin = function( ) { ; } + +/** + * return the label of this search column. + * @return {string} + * + * @method + * @memberOf nlobjSearchColumn + * + * @since 2009.1 + */ +nlobjSearchColumn.prototype.getLabel = function( ) { ; } + +/** + * return the summary type (avg,group,sum,count) of this search column. + * @return {string} + * + * @method + * @memberOf nlobjSearchColumn + * @since 2008.1 + */ +nlobjSearchColumn.prototype.getSummary = function( ) { ; } + +/** + * return formula for this search column. + * @return {string} + * + * @method + * @memberOf nlobjSearchColumn + * + * @since 2009.2 + */ +nlobjSearchColumn.prototype.getFormula = function( ) { ; } + +/** + * return nlobjSearchColumn sorted in either ascending or descending order. + * @return {nlobjSearchColumn} + * @param {boolean} sort if not set, defaults to false, which returns column data in ascending order. + * + * @method + * @memberOf nlobjSearchColumn + * + * @since 2010.1 + */ +nlobjSearchColumn.prototype.setSort = function( order ) { ; } + +/** + * Return a new instance of nlobjSearchResult used for search result row object. + * + * @classDescription Class definition for interacting with the results of a search operation + * @return {nlobjSearchResult} + * @constructor + */ +function nlobjSearchResult( ) { ; } + +/** + * return the internalId for the record returned in this row. + * @method + * @memberOf nlobjSearchResult + * @return {int} + */ +nlobjSearchResult.prototype.getId = function( ) { ; } + +/** + * return the recordtype for the record returned in this row. + * @method + * @memberOf nlobjSearchResult + * @return {string} + */ +nlobjSearchResult.prototype.getRecordType = function( ) { ; } + +/** + * return the value for this nlobjSearchColumn. + * @param {nlobjSearchColumn} column search result column + * @return {string} + * + * @method + * @memberOf nlobjSearchResult + * + * @since 2009.1 + */ +nlobjSearchResult.prototype.getValue = function( column ) { ; } + +/** + * return the value for a return column specified by name, join ID, and summary type. + * @param {string} name the name of the search column + * @param {string} join the join ID for the search column + * @param {string} summary summary type specified for this column + * @return {string} + * + * @method + * @memberOf nlobjSearchResult + * + * @since 2008.1 + */ +nlobjSearchResult.prototype.getValue = function( name, join, summary ) { ; } + +/** + * return the text value for this nlobjSearchColumn if it's a select field. + * @param {nlobjSearchColumn} column search result column + * @return {string} + * + * @method + * @memberOf nlobjSearchResult + * + * @since 2009.1 + */ +nlobjSearchResult.prototype.getText = function( column ) { ; } + +/** + * return the text value of this return column if it's a select field. + * @param {string} name the name of the search column + * @param {string} join the join ID for the search column + * @param {string} summary summary type specified for this column + * @return {string} + * + * @method + * @memberOf nlobjSearchResult + * + * @since 2008.1 + */ +nlobjSearchResult.prototype.getText = function( name, join, summary ) { ; } + +/** + * return an array of all nlobjSearchColumn objects returned in this search. + * @return {nlobjSearchColumn[]} + * + * @method + * @memberOf nlobjSearchResult + * + * @since 2009.2 + */ +nlobjSearchResult.prototype.getAllColumns = function( ) { ; } + +/** + * Return a new instance of nlobjContext used for user and script context information. + * + * @classDescription Utility class providing information about the current user and the script runtime. + * @return {nlobjContext} + * @constructor + */ +function nlobjContext( ) { ; } +/** + * return the name of the current user. + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2007.0 + */ +nlobjContext.prototype.getName = function( ) { ; } + +/** + * return the internalId of the current user. + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2007.0 + */ +nlobjContext.prototype.getUser = function( ) { ; } + +/** + * return the internalId of the current user's role. + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2007.0 + */ +nlobjContext.prototype.getRole = function( ) { ; } + +/** + * return the script ID of the current user's role. + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2008.2 + */ +nlobjContext.prototype.getRoleId = function( ) { ; } + +/** + * return the internalId of the current user's center type. + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2008.2 + */ +nlobjContext.prototype.getRoleCenter = function( ) { ; } + +/** + * return the email address of the current user. + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2007.0 + */ +nlobjContext.prototype.getEmail = function( ) { ; } + +/** + * return the internal ID of the contact logged in on behalf of a customer, vendor, or partner. It returns -1 for non-contact logins + * @return {int} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.1 + */ +nlobjContext.prototype.getContact = function( ) { ; } + +/** + * return the account ID of the current user. + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2007.0 + */ +nlobjContext.prototype.getCompany = function( ) { ; } + +/** + * return the internalId of the current user's department. + * @return {int} + * + * @method + * @memberOf nlobjContext + * + * @since 2007.0 + */ +nlobjContext.prototype.getDepartment = function( ) { ; } + +/** + * return the internalId of the current user's location. + * @return {int} + * + * @method + * @memberOf nlobjContext + * + * @since 2007.0 + */ +nlobjContext.prototype.getLocation = function( ) { ; } + +/** + * return the internalId of the current user's subsidiary. + * @return {int} + * + * @method + * @memberOf nlobjContext + * + * @since 2007.0 + */ +nlobjContext.prototype.getSubsidiary = function( ) { ; } + +/** + * return the execution context for this script: webServices|csvImport|client|userInterface|scheduledScript|portlet|suitelet|debugger|custommassupdate + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2007.0 + */ +nlobjContext.prototype.getExecutionContext = function( ) { ; } + +/** + * return the amount of usage units remaining for this script. + * @return {int} + * + * @method + * @memberOf nlobjContext + * + * @since 2007.0 + */ +nlobjContext.prototype.getRemainingUsage = function( ) { ; } + +/** + * return true if feature is enabled, false otherwise + * @param {string} name + * @return {boolean} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.2 + */ +nlobjContext.prototype.getFeature = function( name ) { ; } + +/** + * return current user's permission level (0-4) for this permission + * @param {string} name + * @return {int} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.2 + */ +nlobjContext.prototype.getPermission = function( name ) { ; } + +/** + * return system or script preference selection for current user + * @param {string} name + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.2 + */ +nlobjContext.prototype.getPreference = function( name ) { ; } + +/** + * return value of session object set by script + * @param {string} name + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.2 + */ +nlobjContext.prototype.getSessionObject = function( name ) { ; } + +/** + * set the value of a session object using a key. + * @param {string} name + * @param {string} value + * @return {void} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.2 + */ +nlobjContext.prototype.setSessionObject = function( name, value ) { ; } + +/** + * return an array containing the names of all keys used to set session objects + * @return {string[]} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.2 + */ +nlobjContext.prototype.getAllSessionObjects = function() { ; } + +/** + * return the NetSuite version for the current account + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.2 + */ +nlobjContext.prototype.getVersion = function( ) { ; } + +/** + * return the environment that the script is executing in: SANDBOX, PRODUCTION, BETA, INTERNAL + * @since 2008.2 + */ +nlobjContext.prototype.getEnvironment = function( ) { ; } + +/** + * return the logging level for the current script execution. Not supported in CLIENT scripts + * @since 2008.2 + */ +nlobjContext.prototype.getLogLevel = function( ) { ; } + +/** + * return the script ID for the current script + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.2 + */ +nlobjContext.prototype.getScriptId = function( ) { ; } + +/** + * return the deployment ID for the current script + * @return {string} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.2 + */ +nlobjContext.prototype.getDeploymentId = function( ) { ; } + +/** + * return the % complete specified for the current scheduled script execution + * @return {int} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.2 + */ +nlobjContext.prototype.getPercentComplete = function( ) { ; } + +/** + * set the % complete for the current scheduled script execution + * @param {float} ct the percentage of records completed + * @return {void} + * + * @method + * @memberOf nlobjContext + * + * @since 2009.2 + */ +nlobjContext.prototype.setPercentComplete = function( pct ) { ; } + +/** + * return a system/script setting. Types are SCRIPT, SESSION, FEATURE, PERMISSION + * + * @param {string} type + * @param {string} name + * @since 2007.0 + * @deprecated + */ +nlobjContext.prototype.getSetting = function( type, name ) { ; } + +/** + * set a system/script setting. Only supported type is SESSION + * + * @param {string} type + * @param {string} name + * @param {string} value + * @since 2007.0 + * @deprecated + */ +nlobjContext.prototype.setSetting = function( type, name, value ) { ; } + +/** + * return an Object containing name/value pairs of color groups to their corresponding RGB hex color based on the currenly logged in user's color them preferences. + * @return {Object} + * + * @method + * @memberOf nlobjContext + * + * @since 2010.1 + */ +nlobjContext.prototype.getColorPreferences = function() { ; } + +/** + * Return a new instance of nlobjError used system or user-defined error object. + * + * @classDescription Encapsulation of errors thrown during script execution. + * @return {nlobjError} + * @constructor + */ +function nlobjError( ) { ; } + +/** + * return the error db ID for this error (if it was an unhandled unexpected error). + * @return {string} + * + * @method + * @memberOf nlobjError + * + * @since 2008.2 + */ +nlobjError.prototype.getId = function( ) { ; } + +/** + * return the error code for this system or user-defined error. + * @return {string} + * + * @method + * @memberOf nlobjError + * + * @since 2008.2 + */ +nlobjError.prototype.getCode = function( ) { ; } + +/** + * return the error description for this error. + * @return {string} + * + * @method + * @memberOf nlobjError + * + * @since 2008.2 + */ +nlobjError.prototype.getDetails = function( ) { ; } + +/** + * return a stacktrace containing the location of the error. + * @return {string[]} + * + * @method + * @memberOf nlobjError + * + * @since 2008.2 + */ +nlobjError.prototype.getStackTrace = function( ) { ; } + +/** + * return the userevent script name where this error was thrown. + * @return {string} + * + * @method + * @memberOf nlobjError + * + * @since 2008.2 + */ +nlobjError.prototype.getUserEvent = function( ) { ; } + +/** + * return the internalid of the record if this error was thrown in an aftersubmit script. + * @return {int} + * + * @method + * @memberOf nlobjError + * + * @since 2008.2 + */ +nlobjError.prototype.getInternalId = function( ) { ; } + +/** + * Return a new instance of nlobjServerResponse.. + * + * @classDescription Contains the results of a server response to an outbound Http(s) call. + * @return {nlobjServerResponse} + * @constructor + * + * @since 2008.1 + */ +function nlobjServerResponse( ) { ; } + +/** + * return the Content-Type header in response + * @return {string} + * + * @method + * @memberOf nlobjServerResponse + * + * @since 2008.1 + */ +nlobjServerResponse.prototype.getContentType = function( ) { ; } + +/** + * return the value of a header returned. + * @param {string} name the name of the header to return + * @return {string} + * + * @method + * @memberOf nlobjServerResponse + * + * @since 2008.1 + */ +nlobjServerResponse.prototype.getHeader = function(name) { ; } + +/** + * return all the values of a header returned. + * @param {string} name the name of the header to return + * @return {string[]} + * + * @method + * @memberOf nlobjServerResponse + * + * @since 2008.1 + */ +nlobjServerResponse.prototype.getHeaders = function(name) { ; } + +/** + * return an Array of all headers returned. + * @return {string[]} + * + * @method + * @memberOf nlobjServerResponse + * + * @since 2008.1 + */ +nlobjServerResponse.prototype.getAllHeaders = function( ) { ; } + +/** + * return the response code returned. + * @return {int} + * + * @method + * @memberOf nlobjServerResponse + * + * @since 2008.1 + */ +nlobjServerResponse.prototype.getCode = function( ) { ; } + +/** + * return the response body returned. + * @return {string} + * + * @method + * @memberOf nlobjServerResponse + * + * @since 2008.1 + */ +nlobjServerResponse.prototype.getBody = function( ) { ; } + +/** + * return the nlobjError thrown via a client call to nlapiRequestURL. + * @return {nlobjError} + * + * @method + * @memberOf nlobjServerResponse + * + * @since 2008.1 + */ +nlobjServerResponse.prototype.getError = function( ) { ; } + +/** + * Return a new instance of nlobjResponse used for scripting web responses in Suitelets + * + * @classDescription Accessor to Http response made available to Suitelets. + * @return {nlobjResponse} + * @constructor + */ +function nlobjResponse( ) { ; } + +/** + * add a value for a response header. + * @param {string} name of header + * @param {string} value for header + * @return {void} + * + * @method + * @memberOf nlobjResponse + * + * @since 2008.2 + */ +nlobjResponse.prototype.addHeader = function( name, value ) { ; } + +/** + * set the value of a response header. + * @param {string} name of header + * @param {string} value for header + * @return {void} + * + * @method + * @memberOf nlobjResponse + * + * @since 2008.2 + */ +nlobjResponse.prototype.setHeader = function( name, value ) { ; } + +/** + * return the value of a response header. + * @param {string} name of header + * @return {string} + * + * @method + * @memberOf nlobjResponse + * + * @since 2008.2 + */ +nlobjResponse.prototype.getHeader = function( ) { ; } + +/** + * return an Array of all response header values for a header + * @param {string} name of header + * @return {string[]} + * + * @method + * @memberOf nlobjResponse + * + * @since 2008.2 + */ +nlobjResponse.prototype.getHeaders = function( name ) { ; } + +/** + * return an Array of all response headers + * @return {Object} + * + * @method + * @memberOf nlobjResponse + * + * @since 2008.2 + */ +nlobjResponse.prototype.getAllHeaders = function( ) { ; } + +/** + * suppress caching for this response. + * @return {void} + * + * @method + * @memberOf nlobjResponse + * + * @since 2009.1 + */ +nlobjResponse.prototype.sendNoCache = function( ) { ; } + +/** + * sets the content type for the response (and an optional filename for binary output). + * + * @param {string} type the file type i.e. plainText, word, pdf, htmldoc (see list of media item types) + * @param {string} filename the file name + * @param {string} disposition Content Disposition used for streaming attachments: inline|attachment + * @return {void} + * @method + * @memberOf nlobjResponse + * + * @since 2008.2 + */ +nlobjResponse.prototype.setContentType = function( type, filename, disposition ) { ; } + +/** + * sets the redirect URL for the response. all URLs must be internal unless the Suitelet is being executed in an "Available without Login" context + * at which point it can use type "external" to specify an external url via the subtype arg + * + * @param {string} type type specifier for URL: suitelet|tasklink|record|mediaitem|external + * @param {string} subtype subtype specifier for URL (corresponding to type): scriptid|taskid|recordtype|mediaid|url + * @param {string} [id] internal ID specifier (sub-subtype corresponding to type): deploymentid|n/a|recordid|n/a + * @param {string} [pagemode] string specifier used to configure page (suitelet: external|internal, tasklink|record: edit|view) + * @param {Object} [parameters] Object used to specify additional URL parameters as name/value pairs + * @return {void} + * @method + * @memberOf nlobjResponse + * + * @since 2008.2 + */ +nlobjResponse.prototype.sendRedirect = function( type, subtype, id, pagemode, parameters ) { ; } + +/** + * write information (text/xml/html) to the response. + * + * @param {string} output + * @return {void} + * @method + * @memberOf nlobjResponse + * + * @since 2008.2 + */ +nlobjResponse.prototype.write = function( output ) { ; } + +/** + * write line information (text/xml/html) to the response. + * + * @param {string} output + * @return {void} + * @method + * @memberOf nlobjResponse + * + * @since 2008.2 + */ +nlobjResponse.prototype.writeLine = function( output ) { ; } + +/** + * write a UI object page. + * + * @param {Object} pageobject page UI object: nlobjList|nlobjAssistant|nlobjForm|nlobjDashboard + * @return {void} + * @method + * @memberOf nlobjResponse + * + * @since 2008.2 + */ +nlobjResponse.prototype.writePage = function( pageobject ) { ; } + +/** + * Return a new instance of nlobjRequest used for scripting web requests in Suitelets + * + * @classDescription Accessor to Http request data made available to Suitelets + * @return {nlobjRequest} + * @constructor + */ +function nlobjRequest( ) { ; } + +/** + * return the value of a request parameter. + * + * @param {string} name parameter name + * @return {string} + * @method + * @memberOf nlobjRequest + * + * @since 2008.2 + */ +nlobjRequest.prototype.getParameter = function( name ) { ; } + +/** + * return the values of a request parameter as an Array. + * + * @param {string} name parameter name + * @return {string[]} + * @method + * @memberOf nlobjRequest + * + * @since 2008.2 + */ +nlobjRequest.prototype.getParameterValues = function( name ) { ; } + +/** + * return an Object containing all the request parameters and their values. + * @return {Object} + * @method + * @memberOf nlobjRequest + * + * @since 2008.2 + */ +nlobjRequest.prototype.getAllParameters = function( ) { ; } + +/** + * return the value of a sublist value. + * @param {string} group sublist name + * @param {string} name sublist field name + * @param {int} line sublist line number + * @return {string} + * + * @method + * @memberOf nlobjRequest + * + * @since 2008.2 + */ +nlobjRequest.prototype.getLineItemValue = function( group, name, line ) { ; } + +/** + * return the number of lines in a sublist. + * @param {string} group sublist name + * @return {int} + * + * @method + * @memberOf nlobjRequest + * + * @since 2008.2 + */ +nlobjRequest.prototype.getLineItemCount = function( group ) { ; } + +/** + * return the value of a request header. + * @param {string} name + * @return {string} + * + * @method + * @memberOf nlobjRequest + * + * @since 2008.2 + */ +nlobjRequest.prototype.getHeader = function( name ) { ; } + +/** + * return an Object containing all the request headers and their values. + * @return {Object} + * + * @method + * @memberOf nlobjRequest + * + * @since 2008.2 + */ +nlobjRequest.prototype.getAllHeaders = function( ) { ; } + +/** + * return the value of an uploaded file. + * @param {string} name file field name + * @return {nlobjFile} + * + * @method + * @memberOf nlobjRequest + * + * @since 2009.1 + */ +nlobjRequest.prototype.getFile = function( name ) { ; } + +/** + * return an Object containing field names to file objects for all uploaded files. + * @return {Object} + * + * @method + * @memberOf nlobjRequest + * + * @since 2009.1 + */ +nlobjRequest.prototype.getAllFiles = function( ) { ; } + +/** + * return the body of the POST request + * @return {string} + * + * @method + * @memberOf nlobjRequest + * @since 2008.1 + */ +nlobjRequest.prototype.getBody = function( ) { ; } + +/** + * return the URL of the request + * @return {string} + * + * @method + * @memberOf nlobjRequest + * @since 2008.1 + */ +nlobjRequest.prototype.getURL = function( ) { ; } + +/** + * return the METHOD of the request + * @return {string} + * + * @method + * @memberOf nlobjRequest + * @since 2008.1 + */ +nlobjRequest.prototype.getMethod = function( ) { ; } + +/** + * Return a new instance of nlobjPortlet used for scriptable dashboard portlet. + * + * @classDescription UI Object used for building portlets that are displayed on dashboard pages + * @return {nlobjPortlet} + * @constructor + */ +function nlobjPortlet( ) { ; } + +/** + * set the portlet title. + * + * @param {string} title + * @since 2008.2 + */ +nlobjPortlet.prototype.setTitle = function( title ) { ; } + +/** + * set the entire contents of the HTML portlet (will be placed inside a ...). + * + * @param {string} html + * @since 2008.2 + */ +nlobjPortlet.prototype.setHtml = function( html ) { ; } + +/** + * add a column (nlobjColumn) to this LIST portlet and return it. + * + * @param {string} name column name + * @param {string} type column type + * @param {string} label column label + * @param {string} [align] column alignment + * @since 2008.2 + */ +nlobjPortlet.prototype.addColumn = function( name, type, label, align ) { ; } + +/** + * add an Edit column (nlobjColumn) to the left of the column specified (supported on LIST portlets only). + * + * @param {nlobjColumn} column + * @param {boolean} showView should Edit|View instead of Edit link + * @param {string} [showHref] column that evaluates to T or F that determines whether to disable the edit|view link per-row. + * @return {nlobjColumn} + * + * @since 2008.2 + */ +nlobjPortlet.prototype.addEditColumn = function( column, showView, showHref ) { ; } + +/** + * add a row (nlobjSearchResult or Array of name-value pairs) to this LIST portlet. + * + * @param {string[]|nlobjSearchResult} row + * @since 2008.2 + */ +nlobjPortlet.prototype.addRow = function( row ) { ; } + +/** + * add multiple rows (Array of nlobjSearchResults or name-value pair Arrays) to this LIST portlet. + * + * @param {string[][]|nlobjSearchResult[]} rows + * @since 2008.2 + */ +nlobjPortlet.prototype.addRows = function( rows ) { ; } + +/** + * add a field (nlobjField) to this FORM portlet and return it. + * + * @param {string} name field name + * @param {string} type field type + * @param {string} [label] field label + * @param {string, int} [source] script ID or internal ID for source list (select and multiselects only) -or- radio value for radio fields + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjPortlet.prototype.addField = function( name,type,label,source ) { ; } + +/** + * add a FORM submit button to this FORM portlet. + * + * @param {string} url URL that this form portlet will POST to + * @param {string} [label] label for submit button (defaults to Save) + * @since 2008.2 + */ +nlobjPortlet.prototype.setSubmitButton = function( url, label ) { ; } + +/** + * add a line (containing text or simple HTML) with optional indenting and URL to this LINKS portlet. + * + * @param {string} text data to output to line + * @param {string} [url] URL if this line should be clickable (if NULL then line will not be clickable) + * @param {int} indent # of indents to insert before text + * @since 2008.2 + */ +nlobjPortlet.prototype.addLine = function( text, url, indent ) { ; } + +/** + * Return a new instance of nlobjList used for scriptable list page. + * + * @classDescription UI Object page type used for building lists + * @return {nlobjList} + * @constructor + */ +function nlobjList( ) { ; } + +/** + * set the page title. + * + * @param {string} title + * @since 2008.2 + */ +nlobjList.prototype.setTitle = function( title ) { ; } + +/** + * set the global style for this list: grid|report|plain|normal. + * + * @param {string} style overall style used to render list + * @since 2008.2 + */ +nlobjList.prototype.setStyle = function( style ) { ; } + +/** + * set the Client SuiteScript used for this page. + * + * @param {string, int} script script ID or internal ID for global client script used to enable Client SuiteScript on page + * @since 2008.2 + */ +nlobjList.prototype.setScript = function( script ) { ; } + +/** + * add a column (nlobjColumn) to this list and return it. + * + * @param {string} name column name + * @param {string} type column type + * @param {string} label column label + * @param {string} [align] column alignment + * @return {nlobjColumn} + * + * @since 2008.2 + */ +nlobjList.prototype.addColumn = function( name, type, label, align ) { ; } + +/** + * add an Edit column (nlobjColumn) to the left of the column specified. + * + * @param {nlobjColumn} column + * @param {boolean} showView should Edit|View instead of Edit link + * @param {string} [showHref] column that evaluates to T or F that determines whether to disable the edit|view link per-row. + * @return {nlobjColumn} + * + * @since 2008.2 + */ +nlobjList.prototype.addEditColumn = function( column, showView, showHref ) { ; } + +/** + * add a row (Array of name-value pairs or nlobjSearchResult) to this portlet. + * + * @param {string[], nlobjSearchResult} row data used to add a single row + * @since 2008.2 + */ +nlobjList.prototype.addRow = function( row ) { ; } + +/** + * add multiple rows (Array of nlobjSearchResults or name-value pair Arrays) to this portlet. + * + * @param {string[][], nlobjSearchResult[]} rows data used to add multiple rows + * @since 2008.2 + */ +nlobjList.prototype.addRows = function( rows ) { ; } + +/** + * add a button (nlobjButton) to the footer of this page. + * + * @param {string} name button name + * @param {string} label button label + * @param {string} script button script (function name) + * @since 2008.2 + */ +nlobjList.prototype.addButton = function( name, label, script ) { ; } + +/** + * add a navigation cross-link to the page. + * + * @param {string} type page link type: crosslink|breadcrumb + * @param {string} title page link title + * @param {string} url URL for page link + * @since 2008.2 + */ +nlobjList.prototype.addPageLink = function( type, title, url ) { ; } + +/** + * Return a new instance of nlobjForm used for scriptable form page. + * + * @classDescription UI Object page type used for building basic data entry forms. + * @return {nlobjForm} + * @constructor + */ +function nlobjForm( ) { ; } + +/** + * set the page title. + * + * @param {string} title + * @since 2008.2 + */ +nlobjForm.prototype.setTitle = function( title ) { ; } + +/** + * set additional title Html. INTERNAL ONLY + * + * @param {string} title + * @since 2008.2 + */ +nlobjForm.prototype.addTitleHtml = function( html ) { ; } + +/** + * set the Client Script definition used for this page. + * + * @param {string, int} script script ID or internal ID for global client script used to enable Client SuiteScript on page + * @since 2008.2 + */ +nlobjForm.prototype.setScript = function( script ) { ; } + +/** + * set the values for all the fields on this form. + * + * @param {Object} values Object containing field name/value pairs + * @since 2008.2 + */ +nlobjForm.prototype.setFieldValues = function( values ) { ; } + +/** + * add a navigation cross-link to the page. + * + * @param {string} type page link type: crosslink|breadcrumb + * @param {string} title page link title + * @param {string} url URL for page link + * @since 2008.2 + */ +nlobjForm.prototype.addPageLink = function( type, title, url ) { ; } + +/** + * add a button to this form. + * + * @param {string} name button name + * @param {string} label button label + * @param {string} script button script (function name) + * @return {nlobjButton} + * + * @since 2008.2 + */ +nlobjForm.prototype.addButton = function( name, label, script ) { ; } + +/** + * get a button from this form by name. + * @param {string} name + * @return {nlobjButton} + * + * @method + * @memberOf nlobjForm + * + * @since 2009.2 add + */ +nlobjForm.prototype.getButton = function( name ) { ; } + +/** + * add a reset button to this form. + * + * @param {string} [label] label for this button. defaults to "Reset" + * @return {nlobjButton} + * + * @since 2008.2 + */ +nlobjForm.prototype.addResetButton = function( label ) { ; } + +/** + * add a submit button to this form. + * + * @param {string} [label] label for this submit button. defaults to "Save" + * @return {nlobjButton} + * + * @since 2008.2 + */ +nlobjForm.prototype.addSubmitButton = function( label ) { ; } + +/** + * add a tab (nlobjTab) to this form and return it. + * + * @param {string} name tab name + * @param {string} label tab label + * @return {nlobjTab} + * + * @since 2008.2 + */ +nlobjForm.prototype.addTab = function( name, label ) { ; } + +/** + * add a field (nlobjField) to this form and return it. + * + * @param {string} name field name + * @param {string} type field type + * @param {string} [label] field label + * @param {string, int} [source] script ID or internal ID for source list (select and multiselects only) -or- radio value for radio fields + * @param {string} [tab] tab name that this field will live on. If empty then the field is added to the main section of the form (immediately below the title bar) + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjForm.prototype.addField = function( name,type,label,sourceOrRadio,tab ) { ; } + +/** + * add a subtab (nlobjTab) to this form and return it. + * + * @param {string} name subtab name + * @param {string} label subtab label + * @param {string} [tab] parent tab that this subtab lives on. If empty, it is added to the main tab. + * @return {nlobjTab} + * + * @since 2008.2 + */ +nlobjForm.prototype.addSubTab = function( name,label,tab ) { ; } + +/** + * add a sublist (nlobjSubList) to this form and return it. + * + * @param {string} name sublist name + * @param {string} type sublist type: inlineeditor|editor|list|staticlist + * @param {string} label sublist label + * @param {string} [tab] parent tab that this sublist lives on. If empty, it is added to the main tab + * @return {nlobjSubList} + * + * @since 2008.2 + */ +nlobjForm.prototype.addSubList = function( name,type,label,tab ) { ; } + +/** + * insert a tab (nlobjTab) before another tab (name). + * + * @param {nlobjTab} tab the tab object to insert + * @param {string} nexttab the name of the tab before which to insert this tab + * @return {nlobjTab} + * + * @since 2008.2 + */ +nlobjForm.prototype.insertTab = function( tab, nexttab ) { ; } + +/** + * insert a field (nlobjField) before another field (name). + * + * @param {nlobjField} field the field object to insert + * @param {string} nextfld the name of the field before which to insert this field + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjForm.prototype.insertField = function( field, nextfld ) { ; } + +/** + * insert a subtab (nlobjTab) before another subtab or sublist (name). + * + * @param {nlobjTab} subtab the subtab object to insert + * @param {string} nextsubtab the name of the subtab before which to insert this subtab + * @return {nlobjTab} + * + * @since 2008.2 + */ +nlobjForm.prototype.insertSubTab = function( subtab, nextsubtab ) { ; } + +/** + * insert a sublist (nlobjSubList) before another subtab or sublist (name). + * + * @param {nlobjSubList} sublist the sublist object to insert + * @param {string} nextsublist the name of the sublist before which to insert this sublist + * @return {nlobjSubList} + * + * @since 2008.2 + */ +nlobjForm.prototype.insertSubList = function( sublist, nextsublist ) { ; } + +/** + * return a tab (nlobjTab) on this form. + * + * @param {string} name tab name + * @return {nlobjTab} + * + * @since 2008.2 + */ +nlobjForm.prototype.getTab = function( name ) { ; } + +/** + * return a field (nlobjField) on this form. + * + * @param {string} name field name + * @param {string} [radio] if this is a radio field, specify which radio field to return based on radio value + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjForm.prototype.getField = function( name, radio ) { ; } + +/** + * return a subtab (nlobjTab) on this form. + * + * @param {string} name subtab name + * @return {nlobjTab} + * + * @since 2008.2 + */ +nlobjForm.prototype.getSubTab = function( name ) { ; } + +/** + * return a sublist (nlobjSubList) on this form. + * + * @param {string} name sublist name + * @return {nlobjSubList} + * + * @since 2008.2 + */ +nlobjForm.prototype.getSubList = function( name ) { ; } + +/** + * add a field group to the form. + * @param {string} name field group name + * @param {string} label field group label + * @param tab + * @return {nlobjFieldGroup} + * + * @method + * @memberOf nlobjForm + * + * @since 2011.1 + */ +nlobjForm.prototype.addFieldGroup = function( name, label, tab ) { ; } + +/** + * Return a new instance of nlobjAssistant. + * + * @classDescription UI Object page type used to build multi-step "assistant" pages to simplify complex workflows. All data and state for an assistant is tracked automatically + * throughout the user's session up until completion of the assistant. + * + * @return {nlobjAssistant} + * @constructor + * + * @since 2009.2 + */ +function nlobjAssistant( ) { ; } +/** + * set the page title. + * @param {string} title + * @return {void} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.setTitle = function( title ) { ; } + +/** + * set the script ID for Client Script used for this form. + * @param {string, int} script script ID or internal ID for global client script used to enable Client SuiteScript on page + * @return {void} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.setScript = function( script ) { ; } + +/** + * set the splash screen used for this page. + * @param {string} title splash portlet title + * @param {string} text1 splash portlet content (left side) + * @param {string} [text2] splash portlet content (right side) + * @return {void} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.setSplash = function( title, text1, text2 ) { ; } + +/** + * show/hide shortcut link. Always hidden on external pages + * @param {boolean} show enable/disable "Add To Shortcut" link on this page + * @return {void} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.setShortcut = function(show) { ; } + +/** + * set the values for all the fields on this page. + * @param {Object} values Object of field name/value pairs used to set all fields on page + * @return {void} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.setFieldValues = function( values ) { ; } + +/** + * if ordered, steps are show on left and must be completed sequentially, otherwise steps are shown on top and can be done in any order + * @param {boolean} ordered If true (default assistant behavior) then a navigation order thru the steps/pages will be imposed on the user. Otherwise the user + * will be allowed to navigate across steps/pages in any order they choose. + * @return {void} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.setOrdered = function(ordered) { ; } + +/** + * if numbered, step numbers are displayed next to the step's label in the navigation area + * @param {boolean} numbered If true (default assistant behavior) step numbers will be displayed next to the step label + * @return {void} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.setNumbered = function(numbered) { ; } + +/** + * return true if all the steps have been completed. + * @return {boolean} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.isFinished = function( ) { ; } + +/** + * mark assistant page as completed and optionally set the rich text to display on completed page. + * @param {string} html completion message (rich text) to display on the "Finish" page + * @return {void} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.setFinished = function( html ) { ; } + +/** + * return true if the assistant has an error message to display for the current step. + * @return {boolean} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.hasError = function( ) { ; } + +/** + * set the error message for the currrent step. + * @param {string} html error message (rich text) to display on the page to the user + * @return {void} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.setError = function( html ) { ; } + +/** + * mark a step as current. It will be highlighted accordingly when the page is displayed + * @param {nlobjAssistantStep} step assistant step object representing the current step that the user is on. + * @return {void} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.setCurrentStep = function( step ) { ; } + +/** + * add a step to the assistant. + * @param {string} name the name of the step + * @param {string} label label used for this step + * @return {nlobjAssistantStep} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.addStep = function( name, label ) { ; } + +/** + * add a field to this page and return it. + * @param {string} name field name + * @param {string} type field type + * @param {string} [label] field label + * @param {string, int} [source] script ID or internal ID for source list (select and multiselects only) -or- radio value for radio fields + * @param {string} [group] group name that this field will live on. If empty then the field is added to the main section of the page + * @return {nlobjField} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.addField = function( name,type,label,source, group ) { ; } + +/** + * add a sublist to this page and return it. For now only sublists of type inlineeditor are supported + * @param {string} name sublist name + * @param {string} type sublist type (inlineeditor only for now) + * @param {string} label sublist label + * @return {nlobjSubList} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.addSubList = function( name,type,label ) { ; } + +/** + * add a field group to the page. + * @param {string} name field group name + * @param {string} label field group label + * @return {nlobjFieldGroup} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.addFieldGroup = function( name, label ) { ; } + +/** + * return an assistant step on this page. + * @param {string} name step name + * @return {nlobjAssistantStep} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getStep = function( name ) { ; } + +/** + * return a field on this page. + * @param {string} name field name + * @return {nlobjField} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getField = function( name ) { ; } + +/** + * return a sublist on this page. + * @param {string} name sublist name + * @return {nlobjSubList} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getSubList = function( name ) { ; } + +/** + * return a field group on this page. + * @param {string} name field group name + * @return {nlobjFieldGroup} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getFieldGroup = function( name ) { ; } + +/** + * return an array of all the assistant steps for this assistant. + * @return {nlobjAssistantStep[]} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getAllSteps = function( ) { ; } + +/** + * return an array of the names of all fields on this page. + * @return {string[]} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getAllFields = function( ) { ; } + +/** + * return an array of the names of all sublists on this page . + * @return {string[]} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getAllSubLists = function( ) { ; } + +/** + * return an array of the names of all field groups on this page. + * @return {string[]} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getAllFieldGroups = function( ) { ; } + +/** + * return the last submitted action by the user: next|back|cancel|finish|jump + * @return {string} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getLastAction = function() { ; } + +/** + * return step from which the last submitted action came from + * @return {nlobjAssistantStep} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getLastStep = function() { ; } + +/** + * return the next logical step corresponding to the user's last submitted action. You should only call this after + * you have successfully captured all the information from the last step and are ready to move on to the next step. You + * would use the return value to set the current step prior to continuing. + * + * @return {nlobjAssistantStep} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getNextStep = function() { ; } + +/** + * return current step set via nlobjAssistant.setCurrentStep(step) + * @return {nlobjAssistantStep} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getCurrentStep = function() { ; } + +/** + * return the total number of steps in the assistant + * @return {int} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.getStepCount = function() { ; } + +/** + * redirect the user following a user submit operation. Use this to automatically redirect the user to the next logical step. + * @param {nlobjResponse} response the response object used to communicate back to the user's client + * @return {void} + * + * @method + * @memberOf nlobjAssistant + * + * @since 2009.2 + */ +nlobjAssistant.prototype.sendRedirect = function(response) { ; } + +/** + * Return a new instance of nlobjField used for scriptable form/sublist field. + * This object is READ-ONLY except for scripted fields created via the UI Object API using Suitelets or beforeLoad user events + * + * @classDescription Core descriptor for fields used to define records and also used to build pages and portlets. + * @return {nlobjField} + * @constructor + */ +function nlobjField( ) { ; } + +/** + * return field name. + * @return {string} + * + * @method + * @memberOf nlobjField + * + * @since 2009.2 + */ +nlobjField.prototype.getName = function( ) { ; } + +/** + * return field label. + * @return {string} + * + * @method + * @memberOf nlobjField + * + * @since 2009.2 + */ +nlobjField.prototype.getLabel = function( ) { ; } + +/** + * return field type. + * @return {string} + * + * @method + * @memberOf nlobjField + * + * @since 2009.2 + */ +nlobjField.prototype.getType = function( ) { ; } + +/** + * return true if field is hidden. + * @return {boolean} + * + * @method + * @memberOf nlobjField + * + * @since 2009.2 + */ +nlobjField.prototype.isHidden = function( ) { ; } + +/** + * return true if field is mandatory. + * @return {boolean} + * + * @method + * @memberOf nlobjField + * + * @since 2009.2 + */ +nlobjField.prototype.isMandatory = function( ) { ; } + +/** + * return true if field is disabled. + * @return {boolean} + * + * @method + * @memberOf nlobjField + * + * @since 2009.2 + */ +nlobjField.prototype.isDisabled = function( ) { ; } + +/** + * set the label for this field. + * This method is only supported on scripted fields via the UI Object API + * + * @param {string} label + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjField.prototype.setLabel = function( label ) { ; } + +/** + * set the alias used to set the value for this field. Defaults to field name. + * This method is only supported on scripted fields via the UI Object API + * + * @param {string} alias column used to populate the field (mostly relevant when populating sublist fields) + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjField.prototype.setAlias = function( alias ) { ; } + +/** + * set the default value for this field. + * This method is only supported on scripted fields via the UI Object API + * + * @param {string} value + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjField.prototype.setDefaultValue = function( value ) { ; } + +/** + * Disable field via field metadata. + * This method is only supported on scripted fields via the UI Object API + * @param {boolean} disabled if true then field should be disabled. + * @return {nlobjField} + * + * @method + * @memberOf nlobjField + * + * @since 2009.2 + */ +nlobjField.prototype.setDisabled = function( disabled ) { ; } + +/** + * make this field mandatory. + * This method is only supported on scripted fields via the UI Object API + * + * @param {boolean} mandatory if true then field becomes mandatory + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjField.prototype.setMandatory = function( mandatory ) { ; } + +/** + * set the maxlength for this field (only valid for certain field types). + * This method is only supported on scripted fields via the UI Object API + * + * @param {int} maxlength maximum length for this field + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjField.prototype.setMaxLength = function( maxlength ) { ; } + +/** + * set the display type for this field. + * This method is only supported on scripted fields via the UI Object API + * + * @param {string} type display type: inline|normal|hidden|disabled|readonly|entry + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjField.prototype.setDisplayType = function( type ) { ; } + +/** + * set the break type (startcol|startrow|none) for this field. startrow is only used for fields with a layout type of outside + * This method is only supported on scripted fields via the UI Object API + * + * @param {string} breaktype break type used to add a break in flow layout for this field: startcol|startrow|none + * @return {nlobjField} + * + * @method + * @memberOf nlobjField + * + * @since 2009.2 + */ +nlobjField.prototype.setBreakType = function( breaktype ) { ; } + + +/** + * set the layout type and optionally the break type. + * This method is only supported on scripted fields via the UI Object API + * + * @param {string} type layout type: outside|startrow|midrow|endrow|normal + * @param {string} [breaktype] break type: startcol|startrow|none + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjField.prototype.setLayoutType = function( type, breaktype ) { ; } + +/** + * set the text that gets displayed in lieu of the field value for URL fields. + * + * @param {string} text user-friendly display value in lieu of URL + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjField.prototype.setLinkText = function( text ) { ; } + +/** + * set the width and height for this field. + * This method is only supported on scripted fields via the UI Object API + * + * @param {int} width + * @param {int} height + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjField.prototype.setDisplaySize = function( width, height ) { ; } + +/** + * set the amount of emppty vertical space (rows) between this field and the previous field. + * This method is only supported on scripted fields via the UI Object API + * + * @param {int} padding # of empty rows to display above field + * @return {nlobjField} + * + * @since 2008.2 + */ +nlobjField.prototype.setPadding = function( padding ) { ; } + +/** + * set help text for this field. If inline is set on assistant pages, help is displayed inline below field + * This method is only supported on scripted fields via the UI Object API + * + * @param {string} help field level help content (rich text) for field + * @param {string} [inline] if true then in addition to the popup field help, the help will also be displayed inline below field (supported on assistant pages only) + * @return {nlobjField} + * + * @method + * @memberOf nlobjField + * + * @since 2009.2 + */ +nlobjField.prototype.setHelpText = function( help, inline ) { ; } + +/** + * add a select option to this field (valid for select/multiselect fields). + * This method is only supported on scripted fields via the UI Object API + * + * @param {string} value internal ID for this select option + * @param {string} text display value for this select option + * @param {boolean} [selected] if true then this select option will be selected by default + * @since 2008.2 + */ +nlobjField.prototype.addSelectOption = function( value, text, selected ) { ; } + +/** + * Return a new instance of nlobjSubList used for scriptable sublist (sublist). + * This object is READ-ONLY except for instances created via the UI Object API using Suitelets or beforeLoad user events. + * + * @classDescription high level container for defining sublist (many to one) relationships on a record or multi-line data entry UIs on pages. + * @return {nlobjSubList} + * @constructor + */ +function nlobjSubList( ) { ; } + +/** + * set the label for this sublist. + * This method is only supported on sublists via the UI Object API + * + * @param {string} label + * @since 2008.2 + */ +nlobjSubList.prototype.setLabel = function( label ) { ; } + +/** + * set helper text for this sublist. + * This method is only supported on sublists via the UI Object API + * + * @param {string} help + * @since 2008.2 + */ +nlobjSubList.prototype.setHelpText = function( help ) { ; } + +/** + * set the displaytype for this sublist: hidden|normal. + * This method is only supported on scripted or staticlist sublists via the UI Object API + * + * @param {string} type + * @since 2008.2 + */ +nlobjSubList.prototype.setDisplayType = function( type ) { ; } + +/** + * set the value of a cell in this sublist. + * + * @param {string} field sublist field name + * @param {int} line line number (1-based) + * @param {string} value sublist value + * + * @method + * @memberOf nlobjSubList + * + * @since 2008.2 + */ +nlobjSubList.prototype.setLineItemValue = function( field, line, value ) { ; } + +/** + * set the value of a matrix cell in this sublist. + * @param {string} field matrix field name + * @param {int} line line number (1-based) + * @param {int} column matrix column index (1-based) + * @param {string} value matrix field value + * @return {void} + * + * @method + * @memberOf nlobjSubList + * + * @since 2009.2 + */ +nlobjSubList.prototype.setLineItemMatrixValue = function( field, line, column, value ) { ; } + +/** + * set values for multiple lines (Array of nlobjSearchResults or name-value pair Arrays) in this sublist. + * Note that this method is only supported on scripted sublists via the UI Object API + * + * @param {string[][], nlobjSearchResult[]} values + * @since 2008.2 + */ +nlobjSubList.prototype.setLineItemValues = function( values ) { ; } + +/** + * Return the number of lines in a sublist. + * + * @param {string} group sublist name + * + * @method + * @memberOf nlobjSubList + * @since 2010.1 + */ +nlobjSubList.prototype.getLineItemCount = function( group ) { ; } + +/** + * add a field (column) to this sublist. + * + * @param {string} name field name + * @param {string} type field type + * @param {string} label field label + * @param {string, int} [source] script ID or internal ID for source list used for this select field + * @return {nlobjField} + * + * @method + * @memberOf nlobjSubList + * + * @since 2008.2 + */ +nlobjSubList.prototype.addField = function( name,type,label,source ) { ; } + +/** + * designate a field on sublist that must be unique across all lines (only supported on sublists of type inlineeditor, editor). + * @param {string} fldnam the name of a field on this sublist whose value must be unique across all lines + * @return {nlobjField} + * + * @method + * @memberOf nlobjSubList + * + * @since 2009.2 + */ +nlobjSubList.prototype.setUniqueField = function( fldnam ) { ; } + +/** + * add a button to this sublist. + * + * @param {string} name button name + * @param {string} label button label + * @param {string} script button script (function name) + * @return {nlobjButton} + * + * @method + * @memberOf nlobjSubList + * + * @since 2008.2 + */ +nlobjSubList.prototype.addButton = function( name, label, script ) { ; } + +/** + * add "Refresh" button to sublists of type "staticlist" to support manual refreshing of the sublist (without entire page reloads) if it's contents are very volatile + * @return {nlobjButton} + * + * @method + * @memberOf nlobjSubList + * + * @since 2009.2 + */ +nlobjSubList.prototype.addRefreshButton = function( ) { ; } + +/** + * add "Mark All" and "Unmark All" buttons to this sublist of type "list". + * + * @method + * @memberOf nlobjSubList + * + * @since 2008.2 + */ +nlobjSubList.prototype.addMarkAllButtons = function( ) { ; } + +/** + * Return a new instance of nlobjColumn used for scriptable list column. + * + * @classDescription Class definition for columns used on lists and list portlets. + * @return {nlobjColumn} + * @constructor + */ +function nlobjColumn( ) { ; } + +/** + * set the header name for this column. + * + * @param {string} label the label for this column + * + * @method + * @memberOf nlobjColumn + * + * @since 2008.2 + */ +nlobjColumn.prototype.setLabel = function( label ) { ; } + +/** + * set the base URL (optionally defined per row) for this column. + * + * @param {string} value the base URL or a column in the datasource that returns the base URL for each row + * @param {boolean} perRow if true then the 1st arg is expected to be a column in the datasource + * + * @method + * @memberOf nlobjColumn + * + * @since 2008.2 + */ +nlobjColumn.prototype.setURL = function( value, perRow ) { ; } + +/** + * add a URL parameter (optionally defined per row) to this column's URL. + * + * @param {string} param the name of a parameter to add to URL + * @param {string} value the value of the parameter to add to URL -or- a column in the datasource that returns the parameter value for each row + * @param {boolean} [perRow] if true then the 2nd arg is expected to be a column in the datasource + * + * @method + * @memberOf nlobjColumn + * + * @since 2008.2 + */ +nlobjColumn.prototype.addParamToURL = function( param, value, perRow ) { ; } + +/** + * Return a new instance of nlobjTab used for scriptable tab or subtab. + * + * @classDescription high level grouping for fields on a data entry form (nlobjForm). + * @return {nlobjTab} + * @constructor + */ +function nlobjTab( ) { ; } + +/** + * set the label for this tab or subtab. + * + * @param {string} label string used as label for this tab or subtab + * @return {nlobjTab} + * + * @since 2008.2 + */ +nlobjTab.prototype.setLabel = function( label ) { ; } + +/** + * set helper text for this tab or subtab. + * + * @param {string} help inline help text used for this tab or subtab + * @return {nlobjTab} + * + * @since 2008.2 + */ +nlobjTab.prototype.setHelpText = function( help ) { ; } + +/** + * Return a new instance of nlobjAssistantStep. + * + * @classDescription assistant step definition. Used to define individual steps/pages in multi-step workflows. + * @return {nlobjAssistantStep} + * @constructor + * + * @since 2009.2 + */ +function nlobjAssistantStep( ) { ; } + +/** + * set the label for this assistant step. + * @param {string} label display label used for this assistant step + * @return {void} + * + * @method + * @memberOf nlobjAssistantStep + * + * @since 2009.2 + */ +nlobjAssistantStep.prototype.setLabel = function( label ) { ; } + +/** + * set helper text for this assistant step. + * @param {string} help inline help text to display on assistant page for this step + * @return {nlobjAssistantStep} + * + * @method + * @memberOf nlobjAssistantStep + * + * @since 2009.2 + */ +nlobjAssistantStep.prototype.setHelpText = function( help ) { ; } + +/** + * return the index of this step in the assistant page (1-based) + * @return {int} the index of this step in the assistant (1-based) based on the order in which the steps were added. + * + * @method + * @memberOf nlobjAssistantStep + * + * @since 2009.2 + */ +nlobjAssistantStep.prototype.getStepNumber = function( ) { ; } + +/** + * return the value of a field entered by the user during this step. + * @param {string} name field name + * @return {string} + * + * @method + * @memberOf nlobjAssistantStep + * + * @since 2009.2 + */ +nlobjAssistantStep.prototype.getFieldValue = function( name ) { ; } + +/** + * return the selected values of a multi-select field as an Array entered by the user during this step. + * @param {string} name multi-select field name + * @return {string[]} + * + * @method + * @memberOf nlobjAssistantStep + * + * @since 2009.2 + */ +nlobjAssistantStep.prototype.getFieldValues = function( name ) { ; } + +/** + * return the number of lines previously entered by the user in this step (or -1 if the sublist does not exist). + * @param {string} group sublist name + * @return {int} + * + * @method + * @memberOf nlobjAssistantStep + * + * @since 2009.2 + */ +nlobjAssistantStep.prototype.getLineItemCount = function( group ) { ; } + +/** + * return the value of a sublist field entered by the user during this step. + * @param {string} group sublist name + * @param {string} name sublist field name + * @param {int} line sublist (1-based) + * @return {string} + * + * @method + * @memberOf nlobjAssistantStep + * + * @since 2009.2 + */ +nlobjAssistantStep.prototype.getLineItemValue = function(group, name, line) { ; } + +/** + * return an array of the names of all fields entered by the user during this step. + * @return {string[]} + * + * @method + * @memberOf nlobjAssistantStep + * + * @since 2009.2 + */ +nlobjAssistantStep.prototype.getAllFields = function( ) { ; } + +/** + * return an array of the names of all sublists entered by the user during this step. + * @return {string[]} + * + * @method + * @memberOf nlobjAssistantStep + * + * @since 2009.2 + */ +nlobjAssistantStep.prototype.getAllLineItems = function( ) { ; } + +/** + * return an array of the names of all sublist fields entered by the user during this step + * @param {string} group sublist name + * @return {string[]} + * + * @method + * @memberOf nlobjAssistantStep + * + * @since 2009.2 + */ +nlobjAssistantStep.prototype.getAllLineItemFields = function( group ) { ; } + +/** + * Return a new instance of nlobjFieldGroup (currently only supported on nlobjAssistant pages) + * + * @classDescription object used for grouping fields on pages (currently only supported on assistant pages). + * @return {nlobjFieldGroup} + * @constructor + * + * @since 2009.2 + */ +function nlobjFieldGroup( ) { ; } + +/** + * set the label for this field group. + * @param {string} label display label for field group + * @return {nlobjFieldGroup} + * + * @method + * @memberOf nlobjFieldGroup + * + * @since 2009.2 + */ +nlobjFieldGroup.prototype.setLabel = function( label ) { ; } + +/** + * set collapsibility property for this field group. + * + * @param {boolean} collapsible if true then this field group is collapsible + * @param {boolean} [defaultcollapsed] if true and the field group is collapsible, collapse this field group by default + * @return {nlobjFieldGroup} + * + * @method + * @memberOf nlobjFieldGroup + * + * @since 2009.2 + */ +nlobjFieldGroup.prototype.setCollapsible = function( collapsible, defaultcollapsed ) { ; } + +/** + * set singleColumn property for this field group. + * + * @param {boolean} singleColumn if true then this field group is displayed in single column + * @return {nlobjFieldGroup} + * + * @method + * @memberOf nlobjFieldGroup + * + * @since 2011.1 + */ +nlobjFieldGroup.prototype.setSingleColumn = function( singleColumn ) { ; } + +/** + * set showBorder property for this field group. + * + * @param {boolean} showBorder if true then this field group shows border including label of group + * @return {nlobjFieldGroup} + * + * @method + * @memberOf nlobjFieldGroup + * + * @since 2011.1 + */ +nlobjFieldGroup.prototype.setShowBorder = function( showBorder ) { ; } + +/** + * Return a new instance of nlobjButton. + * + * @classDescription buttons used for triggering custom behaviors on pages. + * @return {nlobjButton} + * @constructor + * + * @since 2009.2 + */ +function nlobjButton( ) { ; } + +/** + * set the label for this button. + * @param {string} label display label for button + * @return {nlobjButton} + * + * @method + * @memberOf nlobjButton + * + * @since 2008.2 + */ +nlobjButton.prototype.setLabel = function( label ) { ; } + +/** + * disable or enable button. + * @param {boolean} disabled if true then this button should be disabled on the page + * @return {nlobjButton} + * + * @method + * @memberOf nlobjButton + * + * @since 2008.2 + */ +nlobjButton.prototype.setDisabled = function( disabled ) { ; } + +/** + * Return a new instance of nlobjSelectOption. + * + * @classDescription select|radio option used for building select fields via the UI Object API and for describing select|radio fields. + * @return {nlobjSelectOption} + * @constructor + * + * @since 2009.2 + */ +function nlobjSelectOption( ) { ; } + +/** + * return internal ID for select option + * @return {string} + * + * @method + * @memberOf nlobjSelectOption + * + * @since 2009.2 + */ +nlobjSelectOption.prototype.getId = function( ) { ; } + +/** + * return display value for select option. + * @return {string} + * + * @method + * @memberOf nlobjSelectOption + * + * @since 2009.2 + */ +nlobjSelectOption.prototype.getText = function( ) { ; } diff --git a/doc/netsuite/nlapihandler_stubs.js.html b/doc/netsuite/nlapihandler_stubs.js.html new file mode 100644 index 0000000..5675faf --- /dev/null +++ b/doc/netsuite/nlapihandler_stubs.js.html @@ -0,0 +1,4939 @@ + + + + + JSDoc: Source: nlapihandler_stubs.js + + + + + + + + + + +
+ +

Source: nlapihandler_stubs.js

+ + + + + +
+
+ 
/**
+* @projectDescription 	SuiteScript JavaScript library summary.
+*
+* Note that there are some restrictions on API usage. Also note that the only 2 objects that can be
+* contructed are nlobjSearchFilter and nlobjSearchColumn. All other objects can only be created via
+* top-level function or method calls.
+*
+* The @governance tag refers to the usage governance for an API call
+* The @restricted tag refers to any known restrictions with a particular API call
+*
+* All Object arguments are Javascript Objects used as hash tables for specifying key-value pairs
+*
+* @since 	2005.0 Support scripting of current record in Client SuiteScript
+* @version	2007.0 Support scripting of records in user events, portlets, and scheduled scripts
+* @version	2008.1 Support scripting of web requests (Suitelets) and user interfaces (UI Object API)
+* @version	2009.1 Support scripting of file objects
+* @version	2009.2 Support scripting of setup records and assistant (multi-step) pages
+* @version	2009.2 converted JS template to use eclipse code completion friendly format
+* @version	2010.1 Suppport dynamic scripting
+*/
+
+/**
+ * Return a new record using values from an existing record.
+ * @governance 10 units for transactions, 2 for custom records, 4 for all other records
+ *
+ * @param {string} 	type The record type name.
+ * @param {int} 	id The internal ID for the record.
+ * @param {Object} 	initializeValues Contains an array of name/value pairs of defaults to be used during record initialization.
+ * @return {nlobjRecord}  Returns an nlobjRecord object of a copied record.
+ *
+ * @since	2007.0
+ */
+function nlapiCopyRecord(type, id, initializeValues) { ; }
+
+/**
+ * Load an existing record from the system.
+ * @governance 10 units for transactions, 2 for custom records, 4 for all other records
+ *
+ * @param {string} 	type The record type name.
+ * @param {int} 	id The internal ID for the record.
+ * @param {Object} 	initializeValues Contains an array of name/value pairs of defaults to be used during record initialization.
+ * @return {nlobjRecord}  Returns an nlobjRecord object of an existing NetSuite record.
+ *
+ * @exception {SSS_INVALID_RECORD_TYPE}
+ * @exception {SSS_TYPE_ARG_REQD}
+ * @exception {SSS_INVALID_INTERNAL_ID}
+ * @exception {SSS_ID_ARG_REQD}
+ *
+ * @since	2007.0
+ */
+function nlapiLoadRecord(type, id, initializeValues) { ; }
+
+/**
+ * Instantiate a new nlobjRecord object containing all the default field data for that record type.
+ * @governance 10 units for transactions, 2 for custom records, 4 for all other records
+ *
+ * @param {string} type record type ID.
+ * @param {Object} initializeValues Contains an array of name/value pairs of defaults to be used during record initialization.
+ * @return {nlobjRecord}   Returns an nlobjRecord object of a new record from the system.
+ *
+ * @exception {SSS_INVALID_RECORD_TYPE}
+ * @exception {SSS_TYPE_ARG_REQD}
+ *
+ * @since	2007.0
+ */
+function nlapiCreateRecord(type, initializeValues) { ; }
+
+/**
+ * Submit a record to the system for creation or update.
+ * @governance 20 units for transactions, 4 for custom records, 8 for all other records
+ *
+ * @param {nlobjRecord} record nlobjRecord object containing the data record.
+ * @param {boolean} 	[doSourcing] If not set, this argument defaults to false.
+ * @param {boolean} 	[ignoreMandatoryFields] Disables mandatory field validation for this submit operation.
+ * @return {string} internal ID for committed record.
+ *
+ * @exception {SSS_INVALID_RECORD_OBJ}
+ * @exception {SSS_RECORD_OBJ_REQD}
+ * @exception {SSS_INVALID_SOURCE_ARG}
+ *
+ * @since	2007.0
+ */
+function nlapiSubmitRecord(record, doSourcing, ignoreMandatoryFields) { ; }
+
+/**
+ * Delete a record from the system.
+ * @governance 20 units for transactions, 4 for custom records, 8 for all other records
+ *
+ * @param {string} 	type The record type name.
+ * @param {int} 	id The internal ID for the record.
+ * @return {void}
+ *
+ * @exception {SSS_INVALID_RECORD_TYPE}
+ * @exception {SSS_TYPE_ARG_REQD}
+ * @exception {SSS_INVALID_INTERNAL_ID}
+ * @exception {SSS_ID_ARG_REQD}
+ *
+ * @since	2007.0
+ */
+function nlapiDeleteRecord(type, id) { ; }
+
+/**
+ * Perform a record search using an existing search or filters and columns.
+ * @governance 10 units
+ * @restriction returns the first 1000 rows in the search
+ *
+ * @param {string} 		type record type ID.
+ * @param {int, string} [id] The internal ID or script ID for the saved search to use for search.
+ * @param {nlobjSearchFilter, nlobjSearchFilter[]} [filters] [optional] A single nlobjSearchFilter object - or - an array of nlobjSearchFilter objects.
+ * @param {nlobjSearchColumn, nlobjSearchColumn[]} [columns] [optional] A single nlobjSearchColumn object - or - an array of nlobjSearchColumn objects.
+ * @return {nlobjSearchResult[]} Returns an array of nlobjSearchResult objects corresponding to the searched records.
+ *
+ * @exception {SSS_INVALID_RECORD_TYPE}
+ * @exception {SSS_TYPE_ARG_REQD}
+ * @exception {SSS_INVALID_SRCH_ID}
+ * @exception {SSS_INVALID_SRCH_FILTER}
+ * @exception {SSS_INVALID_SRCH_FILTER_JOIN}
+ * @exception {SSS_INVALID_SRCH_OPERATOR}
+ * @exception {SSS_INVALID_SRCH_COL_NAME}
+ * @exception {SSS_INVALID_SRCH_COL_JOIN}
+ *
+ * @since	2007.0
+ */
+function nlapiSearchRecord(type, id, filters, columns) { ; }
+
+/**
+ * Perform a global record search across the system.
+ * @governance 10 units
+ * @restriction returns the first 1000 rows in the search
+ *
+ * @param {string} keywords Global search keywords string or expression.
+ * @return {nlobjSearchResult[]} Returns an Array of nlobjSearchResult objects containing the following four columns: name, type (as shown in the UI), info1, and info2.
+ *
+ * @since	2008.1
+ */
+function nlapiSearchGlobal(keywords) { ; }
+
+/**
+ * Perform a duplicate record search using Duplicate Detection criteria.
+ * @governance 10 units
+ * @restriction returns the first 1000 rows in the search
+ *
+ * @param {string} 		type The recordType you are checking duplicates for (for example, customer|lead|prospect|partner|vendor|contact).
+ * @param {string[]} 	[fields] array of field names used to detect duplicate (for example, companyname|email|name|phone|address1|city|state|zipcode).
+ * @param {int} 		[id] internal ID of existing record. Depending on the use case, id may or may not be a required argument.
+ * @return {nlobjSearchResult[]} Returns an Array of nlobjSearchResult objects corresponding to the duplicate records.
+ *
+ * @since	2008.1
+ */
+function nlapiSearchDuplicate(type, fields, id) { ; }
+
+/**
+ * Create a new record using values from an existing record of a different type.
+ * @governance 10 units for transactions, 2 for custom records, 4 for all other records
+ *
+ * @param {string} 	type The record type name.
+ * @param {int} 	id The internal ID for the record.
+ * @param {string} 	transformType The recordType you are transforming the existing record into.
+ * @param {Object} 	[transformValues] An object containing transform default option/value pairs used to pre-configure transformed record
+ * @return {nlobjRecord}
+ *
+ * @exception {SSS_INVALID_URL_CATEGORY}
+ * @exception {SSS_CATEGORY_ARG_REQD}
+ * @exception {SSS_INVALID_TASK_ID}
+ * @exception {SSS_TASK_ID_REQD}
+ * @exception {SSS_INVALID_INTERNAL_ID}
+ * @exception {SSS_INVALID_EDITMODE_ARG}
+ *
+ * @since	2007.0
+ */
+function nlapiTransformRecord(type, id, transformType, transformValues) { ; }
+
+/**
+ * Fetch the value of one or more fields on a record. This API uses search to look up the fields and is much
+ * faster than loading the record in order to get the field.
+ * @governance 10 units for transactions, 2 for custom records, 4 for all other records
+ *
+ * @param {string} 	type The record type name.
+ * @param {int} 	id The internal ID for the record.
+ * @param {string, string[]} fields - field or fields to look up.
+ * @param {boolean} [text] If set then the display value is returned instead for select fields.
+ * @return {string, Object} single value or an Object of field name/value pairs depending on the fields argument.
+ *
+ * @since	2008.1
+ */
+function nlapiLookupField(type,id,fields, text) { ; }
+
+/**
+ * Submit the values of a field or set of fields for an existing record.
+ * @governance 10 units for transactions, 2 for custom records, 4 for all other records
+ * @restriction only supported for records and fields where DLE (Direct List Editing) is supported
+ *
+ * @param {string} 		type The record type name.
+ * @param {int} 		id The internal ID for the record.
+ * @param {string, string[]} fields field or fields being updated.
+ * @param {string, string[]} values field value or field values used for updating.
+ * @param {boolean} 	[doSourcing] If not set, this argument defaults to false and field sourcing does not occur.
+ * @return {void}
+ *
+ * @since	2008.1
+ */
+function nlapiSubmitField(type,id,fields,values,doSourcing) { ; }
+
+/**
+ * Attach a single record to another with optional properties.
+ * @governance 10 units
+ *
+ * @param {string} 	type1 The record type name being attached
+ * @param {int} 	id1 The internal ID for the record being attached
+ * @param {string} 	type2 The record type name being attached to
+ * @param {int} 	id2 The internal ID for the record being attached to
+ * @param {Object} 	[properties] Object containing name/value pairs used to configure attach operation
+ * @return {void}
+ *
+ * @since	2008.2
+ */
+function nlapiAttachRecord(type1, id1, type2, id2, properties) { ; }
+
+/**
+ * Detach a single record from another with optional properties.
+ * @governance 10 units
+ *
+ * @param {string} 	type1 The record type name being attached
+ * @param {int} 	id1 The internal ID for the record being attached
+ * @param {string} 	type2 The record type name being attached to
+ * @param {int} 	id2 The internal ID for the record being attached to
+ * @param {Object} 	[properties] Object containing name/value pairs used to configure detach operation
+ * @return {void}
+ *
+ * @since	2008.2
+ */
+function nlapiDetachRecord(type1, id1, type2, id2, properties) { ; }
+
+
+/**
+ * Resolve a URL to a resource or object in the system.
+ *
+ * @param {string} type type specifier for URL: suitelet|tasklink|record|mediaitem
+ * @param {string} subtype subtype specifier for URL (corresponding to type): scriptid|taskid|recordtype|mediaid
+ * @param {string} [id] internal ID specifier (sub-subtype corresponding to type): deploymentid|n/a|recordid|n/a
+ * @param {string} [pagemode] string specifier used to configure page (suitelet: external|internal, tasklink|record: edit|view)
+ * @return {string}
+ *
+ * @since	2007.0
+ */
+function nlapiResolveURL(type, subtype, id, pagemode) { ; }
+
+/**
+ * Redirect the user to a page. Only valid in the UI on Suitelets and User Events. In Client scripts this will initialize the redirect URL used upon submit.
+ *
+ * @param {string} type type specifier for URL: suitelet|tasklink|record|mediaitem
+ * @param {string} subtype subtype specifier for URL (corresponding to type): scriptid|taskid|recordtype|mediaid
+ * @param {string} [id] internal ID specifier (sub-subtype corresponding to type): deploymentid|n/a|recordid|n/a
+ * @param {string} [pagemode] string specifier used to configure page (suitelet: external|internal, tasklink|record: edit|view)
+ * @param {Object} [parameters] Object used to specify additional URL parameters as name/value pairs
+ * @return {void}
+ *
+ * @since	2007.0
+ */
+function nlapiSetRedirectURL(type, subtype, id, pagemode, parameters) { ; }
+
+/**
+ * Request a URL to an external or internal resource.
+ * @restriction NetSuite maintains a white list of CAs that are allowed for https requests. Please see the online documentation for the complete list.
+ * @governance 10 units
+ *
+ * @param {string} url 		A fully qualified URL to an HTTP(s) resource
+ * @param {string, Object} 	[postdata] - string, document, or Object containing POST payload
+ * @param {Object} 			[headers] - Object containing request headers.
+ * @param {function} 		[callback] - available on the Client to support asynchronous requests. function is passed an nlobjServerResponse with the results.
+ * @return {nlobjServerResponse}
+ *
+ * @exception {SSS_UNKNOWN_HOST}
+ * @exception {SSS_INVALID_HOST_CERT}
+ * @exception {SSS_REQUEST_TIME_EXCEEDED}
+ *
+ * @since	2007.0
+ */
+function nlapiRequestURL(url, postdata, headers, callback, method) { ; }
+
+/**
+ * Return context information about the current user/script.
+ *
+ * @return {nlobjContext}
+ *
+ * @since	2007.0
+ */
+function nlapiGetContext() { ; }
+
+/**
+ * Return the internal ID for the currently logged in user. Returns -4 when called from online forms or "Available without Login" Suitelets.
+ *
+ * @return {int}
+ *
+ * @since	2005.0
+ */
+function nlapiGetUser() { ; }
+
+/**
+ * Return the internal ID for the current user's role. Returns 31 (Online Form User) when called from online forms or "Available without Login" Suitelets.
+ *
+ * @return {int}
+ *
+ * @since	2005.0
+ */
+function nlapiGetRole() { ; }
+
+/**
+ * Return the internal ID for the current user's department.
+ *
+ * @return {int}
+ *
+ * @since	2005.0
+ */
+function nlapiGetDepartment() { ; }
+
+/**
+ * Return the internal ID for the current user's location.
+ *
+ * @return {int}
+ *
+ * @since	2005.0
+ */
+function nlapiGetLocation() { ; }
+
+/**
+ * Return the internal ID for the current user's subsidiary.
+ *
+ * @return {int}
+ *
+ * @since	2008.1
+ */
+function nlapiGetSubsidiary() { ; }
+
+/**
+ * Return the recordtype corresponding to the current page or userevent script.
+ *
+ * @return {string}
+ *
+ * @since	2007.0
+ */
+function nlapiGetRecordType() { ; }
+
+/**
+ * Return the internal ID corresponding to the current page or userevent script.
+ *
+ *  @return {int}
+ *
+ * @since	2007.0
+ */
+function nlapiGetRecordId() { ; }
+
+/**
+ * Send out an email and associate it with records in the system.
+ * Supported base types are entity for entities, transaction for transactions, activity for activities and cases, record|recordtype for custom records
+ * @governance 10 units
+ * @restriction all outbound emails subject to email Anti-SPAM policies
+ *
+ * @param {int} 		from internal ID for employee user on behalf of whom this email is sent
+ * @param {string, int} to email address or internal ID of user that this email is being sent to
+ * @param {string} 		subject email subject
+ * @param {string} 		body email body
+ * @param {string, string[]} cc copy email address(es)
+ * @param {string, string[]} bcc blind copy email address(es)
+ * @param {Object} 		records Object of base types -> internal IDs used to associate email to records. i.e. {entity: 100, record: 23, recordtype: customrecord_surveys}
+ * @param {nlobjFile[]} files array of nlobjFile objects (files) to include as attachments
+ * @return {void}
+ *
+ * @since	2007.0
+ */
+function nlapiSendEmail(from, to, subject, body, cc, bcc, records, files) { ; }
+
+/**
+ * Sends a single on-demand campaign email to a specified recipient and returns a campaign response ID to track the email.
+ * @governance 10 units
+ * @restriction works in conjunction with the Lead Nurturing (campaigndrip) sublist only
+ *
+ * @param {int} campaigneventid internal ID of the campaign event
+ * @param {int} recipientid internal ID of the recipient - the recipient must have an email
+ * @return {int}
+ *
+ * @since	2010.1
+ */
+function nlapiSendCampaignEmail(campaigneventid, recipientid) { ; }
+
+/**
+ * Send out a fax and associate it with records in the system. This requires fax preferences to be configured.
+ * Supported base types are entity for entities, transaction for transactions, activity for activities and cases, record|recordtype for custom records
+ * @governance 10 units
+ *
+ * @param {int} 		from internal ID for employee user on behalf of whom this fax is sent
+ * @param {string, int} to fax address or internal ID of user that this fax is being sent to
+ * @param {string} 		subject fax subject
+ * @param {string} 		body fax body
+ * @param {Object} 		records Object of base types -> internal IDs used to associate fax to records. i.e. {entity: 100, record: 23, recordtype: customrecord_surveys}
+ * @param {nlobjFile[]} files array of nlobjFile objects (files) to include as attachments
+ * @return {void}
+ *
+ * @since	2008.2
+ */
+function nlapiSendFax(from, to, subject, body, records, files) { ; }
+
+/**
+ * Return field definition for a field.
+ *
+ * @param {string} fldnam the name of the field
+ * @return {nlobjField}
+ *
+ * @since	2009.1
+ */
+function nlapiGetField(fldnam) { ; }
+
+/**
+ * Return field definition for a matrix field.
+ *
+ * @param {string} 	type	matrix sublist name
+ * @param {string} 	fldnam matrix field name
+ * @param {int} 	column matrix field column index (1-based)
+ * @return {nlobjField}
+ *
+ * @since	2009.2
+ */
+function nlapiGetMatrixField(type, fldnam, column) { ; }
+
+/**
+ * Return field definition for a sublist field.
+ *
+ * @param {string} 	type	sublist name
+ * @param {string} 	fldnam sublist field name
+ * @param {int} 	[linenum] line number for sublist field (1-based) and only valid for sublists of type staticlist and list
+ * @return {nlobjField}
+ *
+ * @since	2009.1
+ */
+function nlapiGetLineItemField(type, fldnam, linenum) { ; }
+
+/**
+ * Return an nlobjField containing sublist field metadata.
+ *
+ * @param {string} 	type	matrix sublist name
+ * @param {string} 	fldnam matrix field name
+ * @param {int} 	linenum line number (1-based)
+ * @param {int} 	column matrix column index (1-based)
+ * @return {nlobjField}
+ *
+ * @since	2009.2
+ */
+function nlapiGetLineItemMatrixField(type, fldnam, linenum, column) { ; }
+
+/**
+ * Return the value of a field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} fldnam the field name
+ * @return {string}
+ *
+ * @since	2005.0
+ */
+function nlapiGetFieldValue(fldnam) { ; }
+
+/**
+ * Set the value of a field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @restriction synchronous arg is only supported in client SuiteScript
+ *
+ * @param {string} 	fldnam the field name
+ * @param {string} 	value value used to set field
+ * @param {boolean} [firefieldchanged]	if false then the field change event is suppressed (defaults to true)
+ * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false).
+ * @return {void}
+ *
+ * @since	2005.0
+ */
+function nlapiSetFieldValue(fldnam,value,firefieldchanged,synchronous) { ; }
+
+/**
+ * Return the display value of a select field's current selection on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} fldnam the field name
+ * @return {string}
+ *
+ * @since	2005.0
+ */
+function nlapiGetFieldText(fldnam) { ; }
+
+/**
+ * Set the value of a field on the current record on a page using it's label.
+ * @restriction synchronous arg is only supported in client SuiteScript
+ *
+ * @param {string} 	fldnam the field name
+ * @param {string} 	txt display name used to lookup field value
+ * @param {boolean} [firefieldchanged]	if false then the field change event is suppressed (defaults to true)
+ * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false).
+ * @return {void}
+ *
+ * @since	2005.0
+ */
+function nlapiSetFieldText(fldnam,txt,firefieldchanged,synchronous)	{ ; }
+
+/**
+ * Return the values of a multiselect field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} fldnam the field name
+ * @return {string[]}
+ *
+ * @since	2005.0
+ */
+function nlapiGetFieldValues(fldnam) { ; }
+
+/**
+ * Set the values of a multiselect field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @restriction synchronous arg is only supported in client SuiteScript
+ *
+ * @param {string} 		fldnam field name
+ * @param {string[]} 	values array of strings containing values for field
+ * @param {boolean} 	[firefieldchanged] if false then the field change event is suppressed (defaults to true)
+ * @param {boolean} 	[synchronous] if true then sourcing and field change execution happens synchronously (defaults to false).
+ * @return {void}
+ *
+ * @since	2005.0
+ */
+function nlapiSetFieldValues(fldnam,values,firefieldchanged,synchronous) { ; }
+
+/**
+ * Return the values (via display text) of a multiselect field on the current record.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} fldnam field name
+ * @return {string[]}
+ *
+ * @since	2009.1
+ */
+function nlapiGetFieldTexts(fldnam) { ; }
+
+/**
+ * Set the values (via display text) of a multiselect field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @restriction synchronous arg is only supported in client SuiteScript
+ *
+ * @param {string} 		fldnam field name
+ * @param {string[]}	texts array of strings containing display values for field
+ * @param {boolean}		[firefieldchanged]	if false then the field change event is suppressed (defaults to true)
+ * @param {boolean} 	[synchronous] if true then sourcing and field change execution happens synchronously (defaults to false).
+ * @return {void}
+ *
+ * @since	2009.1
+ */
+function nlapiSetFieldTexts(fldnam,texts,firefieldchanged,synchronous) { ; }
+
+/**
+ * Get the value of a matrix header field
+ *
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @param {int} 	column matrix column index (1-based)
+ * @return {string}
+ *
+ * @since	2009.2
+ */
+function nlapiGetMatrixValue(type, fldnam, column) { ; }
+
+/**
+ * Set the value of a matrix header field
+ * @restriction synchronous arg is only supported in client SuiteScript
+ *
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @param {int} 	column matrix column index (1-based)
+ * @param {string} 	value field value for matrix field
+ * @param {boolean} [firefieldchanged]	if false then the field change event is suppressed (defaults to true)
+ * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false).
+ * @return {void}
+ *
+ * @since	2009.2
+ */
+function nlapiSetMatrixValue(type, fldnam, column, value, firefieldchanged, synchronous) { ; }
+
+/**
+ * Get the current value of a sublist field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @param {int} 	column matrix column index (1-based)
+ * @return {string} value
+ *
+ * @since	2009.2
+ */
+function nlapiGetCurrentLineItemMatrixValue(type, fldnam, column) { ; }
+
+/**
+ * Set the current value of a sublist field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @restriction synchronous arg is only supported in Client SuiteScript
+ *
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @param {int} 	column matrix column index (1-based)
+ * @param {string} 	value matrix field value
+ * @param {boolean} [firefieldchanged] if false then the field change event is suppressed (defaults to true)
+ * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false).
+ * @return {void}
+ *
+ * @since	2009.2
+ */
+function nlapiSetCurrentLineItemMatrixValue(type, fldnam, column, value, firefieldchanged, synchronous) { ; }
+
+/**
+ * Return the value of a sublist matrix field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @param {int} 	linenum line number (1-based)
+ * @param {int} 	column column index (1-based)
+ * @param {string} value
+ *
+ * @since	2009.2
+ */
+function nlapiGetLineItemMatrixValue(type, fldnam, linenum, column) { ; }
+
+/**
+ * Return the value of a sublist field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @param {int} 	linenum line number (1-based)
+ * @return {string}
+ *
+ * @since 2005.0
+ */
+function nlapiGetLineItemValue(type,fldnam,linenum) { ; }
+
+/**
+ * Set the value of a sublist field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @param {int} 	linenum line number (1-based)
+ * @param {string} value
+ * @retun {void}
+ *
+ * @since 2005.0
+ */
+function nlapiSetLineItemValue(type,fldnam,linenum,value) { ; }
+
+/**
+ * Return the label of a select field's current selection for a particular line.
+ *
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @param {int} 	linenum line number (1-based)
+ * @return {string}
+ *
+ * @since 2005.0
+ */
+function nlapiGetLineItemText(type,fldnam,linenum) { ; }
+
+/**
+ * Return the 1st line number that a sublist field value appears in
+ *
+ * @param {string} type sublist name
+ * @param {string} fldnam sublist field name
+ * @param {string} val the value being queried for in a sublist field
+ * @return {int}
+ *
+ * @since 2009.2
+ */
+function nlapiFindLineItemValue(type, fldnam, val) { ; }
+
+/**
+ * Return the 1st line number that a matrix field value appears in
+ *
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam matrix field name
+ * @param {int} 	column matrix column index (1-based)
+ * @param {string} 	val the value being queried for in a matrix field
+ * @return {int}
+ *
+ * @since 2009.2
+ */
+function nlapiFindLineItemMatrixValue(type, fldnam, column, val) { ; }
+
+/**
+ * Return the number of columns for a matrix field
+ *
+ * @param {string} type sublist name
+ * @param {string} fldnam matrix field name
+ * @return {int}
+ *
+ * @since 2009.2
+ */
+function nlapiGetMatrixCount(type, fldnam) { ; }
+
+/**
+ * Return the number of sublists in a sublist on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} type sublist name
+ * @return {int}
+ *
+ * @since 2005.0
+ */
+function nlapiGetLineItemCount(type) { ; }
+
+/**
+ * Insert and select a new line into the sublist on a page or userevent.
+ *
+ * @param {string} type sublist name
+ * @param {int} [line] line number at which to insert a new line.
+ * @return{void}
+ *
+ * @since 2005.0
+ */
+function nlapiInsertLineItem(type, line) { ; }
+
+/**
+ * Remove the currently selected line from the sublist on a page or userevent.
+ *
+ * @param {string} type sublist name
+ * @param {int} [line]	line number to remove.
+ * @return {void}
+ *
+ * @since 2005.0
+ */
+function nlapiRemoveLineItem(type, line) { ; }
+
+/**
+ * Set the value of a field on the currently selected line.
+ * @restriction synchronous arg is only supported in client SuiteScript
+ *
+ * @param {string} type sublist name
+ * @param {string} fldnam sublist field name
+ * @param {string} value field value
+ * @param {boolean} [firefieldchanged]	if false then the field change event is suppressed (defaults to true)
+ * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false).
+ * @return {void}
+ *
+ * @since 2005.0
+ */
+function nlapiSetCurrentLineItemValue(type,fldnam,value,firefieldchanged,synchronous) { ; }
+
+/**
+ * Set the value of a field on the currently selected line using it's label.
+ * @restriction synchronous arg is only supported in client SuiteScript
+ *
+ * @param {string} type sublist name
+ * @param {string} fldnam sublist field name
+ * @param {string} txt string containing display value or search text.
+ * @param {boolean} [firefieldchanged]	if false then the field change event is suppressed (defaults to true)
+ * @param {boolean} [synchronous] if true then sourcing and field change execution happens synchronously (defaults to false).
+ * @return {void}
+ *
+ * @since 2005.0
+ */
+function nlapiSetCurrentLineItemText(type,fldnam,txt,firefieldchanged,synchronous) { ; }
+
+/**
+ * Return the value of a field on the currently selected line.
+ *
+ * @param {string} type sublist name
+ * @param {string} fldnam sublist field name
+ * @return {string}
+ *
+ * @since 2005.0
+ */
+function nlapiGetCurrentLineItemValue(type,fldnam) { ; }
+
+/**
+ * Return the label of a select field's current selection on the currently selected line.
+ *
+ * @param {string} type sublist name
+ * @param {string} fldnam sublist field name
+ * @return {string}
+ *
+ * @since 2005.0
+ */
+function nlapiGetCurrentLineItemText(type,fldnam) { ; }
+
+/**
+ * Return the line number for the currently selected line.
+ *
+ * @param {string} type sublist name
+ * @return {int}
+ *
+ * @since 2005.0
+ */
+function nlapiGetCurrentLineItemIndex(type) { ; }
+
+/**
+ * Disable a sublist field.
+ * @restriction Only supported on sublists of type inlineeditor, editor and list (current field only)
+ *
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @param {boolean} disable if true then field is disabled
+ * @param {int} linenum line number for sublist field (1-based) and only valid for sublists of type list
+ * @return {void}
+ *
+ * @since 2009.1
+ */
+function nlapiSetLineItemDisabled(type,fldnam,disable, linenum) { ; }
+
+/**
+ * Return field mandatoriness.
+ *
+ * @param {string} fldnam field name
+ * @return {boolean}
+ *
+ * @since 2009.1
+ */
+function nlapiGetFieldMandatory(fldnam) { ; }
+
+/**
+ * Return sublist field mandatoriness.
+ * @restriction Only supported on sublists of type inlineeditor or editor (current field only)
+ *
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @return {boolean}
+ *
+ * @since 2009.1
+ */
+function nlapiGetLineItemMandatory(type,fldnam) { ; }
+
+/**
+ * Make a field mandatory.
+ *
+ * @param {string} 	fldnam field name
+ * @param {boolean} mandatory if true then field is made mandatory
+ * @return {void}
+ *
+ * @since 2009.1
+ */
+function nlapiSetFieldMandatory(fldnam,mandatory) { ; }
+
+/**
+ * Make a sublist field mandatory.
+ * @restriction Only supported on sublists of type inlineeditor or editor (current field only)
+ *
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @param {boolean} mandatory if true then field is made mandatory
+ * @return {void}
+ *
+ * @since 2009.2
+ */
+function nlapiSetLineItemMandatory(type,fldnam,mandatory) { ; }
+
+/**
+ * Select an existing line in a sublist.
+ *
+ * @param {string} type sublist name
+ * @param {int} linenum line number to select
+ * @return {void}
+ *
+ * @since 2005.0
+ */
+function nlapiSelectLineItem(type, linenum) { ; }
+
+/**
+ * Save changes made on the currently selected line to the sublist.
+ *
+ * @param {string} type sublist name
+ * @return {void}
+ *
+ * @since 2005.0
+ */
+function nlapiCommitLineItem(type) { ; }
+
+/**
+ * Cancel any changes made on the currently selected line.
+ * @restriction Only supported for sublists of type inlineeditor and editor
+ *
+ * @param {string} type sublist name
+ * @return {void}
+ *
+ * @since 2005.0
+ */
+function nlapiCancelLineItem(type) { ; }
+
+/**
+ * Select a new line in a sublist.
+ * @restriction Only supported for sublists of type inlineeditor and editor
+ *
+ * @param {string} type sublist name
+ * @return {void}
+ *
+ * @since 2005.0
+ */
+function nlapiSelectNewLineItem(type) { ; }
+
+/**
+ * Refresh the sublist table.
+ * @restriction Only supported for sublists of type inlineeditor, editor, and staticlist
+ * @restriction Client SuiteScript only.
+ *
+ * @param {string} type sublist name
+ * @return{void}
+ *
+ * @since 2005.0
+ */
+function nlapiRefreshLineItems(type) { ; }
+
+/**
+ * Adds a select option to a scripted select or multiselect field.
+ * @restriction Client SuiteScript only
+ *
+ * @param {string} fldnam field name
+ * @param {string} value internal ID for select option
+ * @param {string} text display text for select option
+ * @param {boolean} [selected] if true then option will be selected by default
+ * @return {void}
+ *
+ * @since 2008.2
+ */
+function nlapiInsertSelectOption(fldnam, value, text, selected) { ; }
+
+/**
+ * Removes a select option (or all if value is null) from a scripted select or multiselect field.
+ * @restriction Client SuiteScript only
+ *
+ * @param {string} fldnam field name
+ * @param {string} value internal ID of select option to remove
+ * @return {void}
+ *
+ * @since 2008.2
+ */
+function nlapiRemoveSelectOption(fldnam, value) { ; }
+
+/**
+ * Adds a select option to a scripted select or multiselect sublist field.
+ * @restriction Client SuiteScript only
+ *
+ * @param {string} type	sublist name
+ * @param {string} fldnam sublist field name
+ * @param {string} value internal ID for select option
+ * @param {string} text display text for select option
+ * @param {boolean} [selected] if true then option will be selected by default
+ * @return {void}
+ *
+ * @since 2008.2
+ */
+function nlapiInsertLineItemOption(type, fldnam, value, text, selected) { ; }
+
+/**
+ * Removes a select option (or all if value is null) from a scripted select or multiselect sublist field.
+ * @restriction Client SuiteScript only
+ *
+ * @param {string} type	sublist name
+ * @param {string} fldnam sublist field name
+ * @param {string} value internal ID for select option to remove
+ * @return {void}
+ *
+ * @since 2008.2
+ */
+function nlapiRemoveLineItemOption(type, fldnam, value) { ; }
+
+/**
+ * Returns true if any changes have been made to a sublist.
+ * @restriction Client SuiteScript only
+ *
+ * @param {string} type sublist name
+ * @return {boolean}
+ *
+ * @since 2005.0
+ */
+function nlapiIsLineItemChanged(type) { ; }
+
+/**
+ * Return an record object containing the data being submitted to the system for the currenr record.
+ * @restriction User Event scripts only
+ *
+ * @return {nlobjRecord}
+ *
+ * @since 2008.1
+ */
+function nlapiGetNewRecord() { ; }
+
+/**
+ * Return an record object containing the current record's data prior to the write operation.
+ * @restriction beforeSubmit|afterSubmit User Event scripts only
+ *
+ * @return {nlobjRecord}
+ *
+ * @since 2008.1
+ */
+function nlapiGetOldRecord() { ; }
+
+/**
+ * Create an nlobjError object that can be used to abort script execution and configure error notification
+ *
+ * @param {string} 	code error code
+ * @param {string} 	details error description
+ * @param {boolean} [suppressEmail] if true then suppress the error notification emails from being sent out (false by default).
+ * @return {nlobjError}
+ *
+ * @since 2008.2
+ */
+function nlapiCreateError(code,details,suppressEmail) { ; }
+
+/**
+ * Return a new entry form page.
+ * @restriction Suitelets only
+ *
+ * @param {string} 	title page title
+ * @param {boolean} [hideHeader] true to hide the page header (false by default)
+ * @return {nlobjForm}
+ *
+ * @since 2008.2
+ */
+function nlapiCreateForm(title, hideHeader) { ; }
+
+/**
+ * Return a new list page.
+ * @restriction Suitelets only
+ *
+ * @param {string} 	title page title
+ * @param {boolean} [hideHeader] true to hide the page header (false by default)
+ * @return {nlobjList}
+ *
+ * @since 2008.2
+ */
+function nlapiCreateList(title, hideHeader) { ; }
+
+/**
+ * Return a new assistant page.
+ * @restriction Suitelets only
+ *
+ * @param {string} 	title page title
+ * @param {boolean} [hideHeader] true to hide the page header (false by default)
+ * @return {nlobjAssistant}
+ *
+ * @since 2009.2
+ */
+function nlapiCreateAssistant(title, hideHeader) { ; }
+
+/**
+ * Load a file from the file cabinet (via its internal ID or path).
+ * @governance 10 units
+ * @restriction Server SuiteScript only
+ *
+ * @param {string, int} id internal ID or relative path to file in the file cabinet (i.e. /SuiteScript/foo.js)
+ * @return {nlobjFile}
+ *
+ * @since 2008.2
+ */
+function nlapiLoadFile(id) { ; }
+
+/**
+ * Add/update a file in the file cabinet.
+ * @governance 20 units
+ * @restriction Server SuiteScript only
+ *
+ * @param {nlobjFile} file a file object to submit
+ * @return {int} return internal ID of file
+ *
+ * @since 2009.1
+ */
+function nlapiSubmitFile(file) { ; }
+
+/**
+ * Delete a file from the file cabinet.
+ * @governance 20 units
+ * @restriction Server SuiteScript only
+ *
+ * @param {int} id internal ID of file to be deleted
+ * @return {id}
+ *
+ * @since 2009.1
+ */
+function nlapiDeleteFile(id) { ; }
+
+/**
+ * Instantiate a file object (specifying the name, type, and contents which are base-64 encoded for binary types.)
+ * @restriction Server SuiteScript only
+ *
+ * @param {string} name file name
+ * @param {string} type file type i.e. plainText, htmlDoc, pdf, word (see documentation for the list of supported file types)
+ * @param {string} contents string containing file contents (must be base-64 encoded for binary types)
+ * @return {nlobjFile}
+ *
+ * @since 2009.1
+ */
+function nlapiCreateFile(name, type, contents) { ; }
+
+/**
+ * Perform a mail merge operation using any template and up to 2 records and returns an nlobjFile with the results.
+ * @restriction only supported for record types that are available in mail merge: transactions, entities, custom records, and cases
+ * @restriction Server SuiteScript only
+ * @governance 10 units
+ *
+ * @param {int} 	id internal ID of template
+ * @param {string} 	baseType primary record type
+ * @param {int} 	baseId internal ID of primary record
+ * @param {string} 	[altType] secondary record type
+ * @param {int} 	[altId] internal ID of secondary record
+ * @param {Object} 	[fields] Object of merge field values to use in the mail merge (by default all field values are obtained from records) which overrides those from the record.
+ * @return {nlobjFile}
+ *
+ * @since 2008.2
+ */
+function nlapiMergeRecord(id, baseType, baseId, altType, altId, fields) { ; }
+
+/**
+ * Print a record (transaction) gievn its type, id, and output format.
+ * @restriction Server SuiteScript only
+ * @governance 10 units
+ *
+ * @param {string} 	type print output type: transaction|statement|packingslip|pickingticket
+ * @param {int} 	id internal ID of record to print
+ * @param {string} 	[format] output format: html|pdf|default
+ * @param {Object} 	[properties] Object of properties used to configure print
+ * @return {nlobjFile}
+ *
+ * @since 2008.2
+ */
+function nlapiPrintRecord(type, id, format, properties) { ; }
+
+/**
+ * Generate a PDF from XML using the BFO report writer (see http://big.faceless.org/products/report/).
+ * @restriction Server SuiteScript only
+ * @governance 10 units
+ *
+ * @param {string} input string containing BFO compliant XHTML
+ * @return {nlobjFile}
+ *
+ * @since 2009.1
+ */
+function nlapiXMLToPDF(input) { ; }
+
+/**
+ * Create an entry in the script execution log (note that execution log entries are automatically purged after 30 days).
+ *
+ * @param {string} type	log type: debug|audit|error|emergency
+ * @param {string} title log title (up to 90 characters supported)
+ * @param {string} [details] log details (up to 3000 characters supported)
+ * @return {void}
+ *
+ * @since 2008.1
+ */
+function nlapiLogExecution(type, title, details) { ; }
+
+/**
+ * Queue a scheduled script for immediate execution and return the status QUEUED if successfull.
+ * @restriction Server SuiteScript only
+ * @governance 20 units
+ *
+ * @param {string, int}	script script ID or internal ID of scheduled script
+ * @param {string, int} [deployment] script ID or internal ID of scheduled script deployment. If empty, the first "free" deployment (i.e. status = Not Scheduled or Completed) will be used
+ * @param {Object} 		parameters Object of parameter name->values used in this scheduled script instance
+ * @return {string}	QUEUED or null if no available deployments were found or the current status of the deployment specified if it was not available.
+ *
+ * @since 2008.1
+ */
+function nlapiScheduleScript(script, deployment, parameters) { ; }
+
+/**
+ * Return a URL with a generated OAuth token.
+ * @restriction Suitelets and Portlets only
+ * @governance 20 units
+ *
+ * @param {string} ssoAppKey
+ * @return {string}
+ *
+ * @since 2009.2
+ */
+function nlapiOutboundSSO(ssoAppKey) { ; }
+
+/**
+ * Loads a configuration record
+ * @restriction Server SuiteScript only
+ * @governance 10 units
+ *
+ * @param {string} type
+ * @return {nlobjConfiguration}
+ *
+ * @since 2009.2
+ */
+function nlapiLoadConfiguration(type) { ; }
+
+/**
+ * Commits all changes to a configuration record.
+ * @restriction Server SuiteScript only
+ * @governance 10 units
+ *
+ * @param {nlobjConfiguration} setup record
+ * @return (void)
+ *
+ * @since 2009.2
+ */
+function nlapiSubmitConfiguration(setup) { ; }
+
+/**
+ * Convert a String into a Date object.
+ *
+ * @param {string} str date string in the user's date format, timeofday format, or datetime format
+ * @param {string} format format type to use: date|datetime|timeofday with date being the default
+ * @return {date}
+ *
+ * @since 2005.0
+ */
+function nlapiStringToDate(str, format) { ; }
+
+/**
+ * Convert a Date object into a String
+ *
+ * @param {date} 	d date object being converted to a string
+ * @param {string} [formattype] format type to use: date|datetime|timeofday with date being the default
+ * @return {string}
+ *
+ * @since 2005.0
+ */
+function nlapiDateToString(d, formattype) { ; }
+
+/**
+ * Add days to a Date object and returns a new Date
+ *
+ * @param {date} d date object used to calculate the new date
+ * @param {int}	days the number of days to add to this date object.
+ * @return {date}
+ *
+ * @since 2008.1
+ */
+function nlapiAddDays(d, days) { ; }
+
+/**
+ * Add months to a Date object and returns a new Date.
+ *
+ * @param {date} d date object used to calculate the new date
+ * @param {int} months the number of months to add to this date object.
+ * @return {date}
+ *
+ * @since 2008.1
+ */
+function nlapiAddMonths(d, months) { ; }
+
+/**
+ * Format a number for data entry into a currency field.
+ *
+ * @param {string} str numeric string used to format for display as currency using user's locale
+ * @return {string}
+ *
+ * @since 2008.1
+ */
+function nlapiFormatCurrency(str) { ; }
+
+/**
+ * Encrypt a String using a SHA-1 hash function
+ *
+ * @param {string} s string to encrypt
+ * @return {string}
+ *
+ * @since 2009.2
+ */
+function nlapiEncrypt(s) { ; }
+
+/**
+ * Escape a String for use in an XML document.
+ *
+ * @param {string} text string to escape
+ * @return {string}
+ *
+ * @since 2008.1
+ */
+function nlapiEscapeXML(text) { ; }
+
+/**
+ * Convert a String into an XML document. Note that in Server SuiteScript XML is supported natively by the JS runtime using the e4x standard (http://en.wikipedia.org/wiki/E4X)
+ * This makes scripting XML simpler and more efficient
+ *
+ * @param {string} str string being parsed into an XML document
+ * @return {document}
+ *
+ * @since 2008.1
+ */
+function nlapiStringToXML(str) { ; }
+
+/**
+ * Convert an XML document into a String.  Note that in Server SuiteScript XML is supported natively by the JS runtime using the e4x standard (http://en.wikipedia.org/wiki/E4X)
+ * This makes scripting XML data simpler and more efficient
+ *
+ * @param {document} xml document being serialized into a string
+ * @return {string}
+ *
+ * @since 2008.1
+ */
+function nlapiXMLToString(xml) { ; }
+
+/**
+ * select a value from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix)
+ *
+ * @param {node} node node being queried
+ * @param {string} xpath string containing XPath expression.
+ * @return {string}
+ *
+ * @since 2008.2
+ */
+function nlapiSelectValue(node, xpath) { ; }
+
+/**
+ * Select an array of values from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix)
+ *
+ * @param {node} 	node node being queried
+ * @param {string} 	xpath string containing XPath expression.
+ * @return {string[]}
+ *
+ * @since 2008.1
+ */
+function nlapiSelectValues(node, xpath) { ; }
+
+/**
+ * Select a node from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix)
+ *
+ * @param {node} 	node node being queried
+ * @param {string} 	xpath string containing XPath expression.
+ * @return {node}
+ *
+ * @since 2008.1
+ */
+function nlapiSelectNode(node, xpath) { ; }
+
+/**
+ * Select an array of nodes from an XML node using XPath. Supports custom namespaces (nodes in default namespace can be referenced using "nlapi" as the prefix)
+ *
+ * @param {node} 	node node being queried
+ * @param {string} 	xpath string containing XPath expression.
+ * @return {node[]}
+ *
+ * @since 2008.1
+ */
+function nlapiSelectNodes(node, xpath) { ; }
+
+/**
+ * Calculate exchange rate between two currencies as of today or an optional effective date.
+ * @governance 10 units
+ *
+ * @param {string, int} fromCurrency internal ID or currency code of currency we are converting from
+ * @param {string, int} toCurrency internal ID or currency code of currency we are converting to
+ * @param {string} [date] string containing date of effective exchange rate. defaults to today
+ * @return {float}
+ *
+ * @since 2009.1
+ */
+function nlapiExchangeRate(fromCurrency, toCurrency, date) { ; }
+
+/**
+ * Initiates a workflow on-demand and returns the workflow instance ID for the workflow-record combination.
+ * @governance 20 units
+ *
+ * @param {string} recordtype record type ID of the workflow base record
+ * @param {int} id internal ID of the base record
+ * @param {string, int} workflowid internal ID or script ID for the workflow definition
+ * @return {int}
+ *
+ * @since 2010.1
+ */
+function nlapiInitiateWorkflow(recordtype, id, workflowid) { ; }
+
+/**
+ * Triggers a workflow on a record.
+ * @governance 20 units
+ *
+ * @param {string} recordtype record type ID of the workflow base record
+ * @param {int} id internal ID of the base record
+ * @param {string, int} workflowid internal ID or script ID for the workflow definition
+ * @param {string, int} actionid internal ID or script ID of the action script
+ * @return {int}
+ *
+ * @since 2010.1
+ */
+function nlapiTriggerWorkflow(recordtype, id, workflowid, actionid) { ; }
+
+/**
+ * Create a subrecord on a sublist field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @retun {nlobjSubrecord}
+ *
+ * @since 2011.2
+ */
+function nlapiCreateCurrentLineSubrecord(type,fldnam) { ; }
+
+/**
+ * edit a subrecord on a sublist field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @retun {nlobjSubrecord}
+ *
+ * @since 2011.2
+ */
+function nlapiEditCurrentLineItemSubrecord(type,fldnam) { ; }
+
+/**
+ * remove a subrecord on a sublist field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @retun {void}
+ *
+ * @since 2011.2
+ */
+function nlapiRemoveCurrentLineItemSubrecord(type,fldnam) { ; }
+
+
+/**
+ * view a subrecord on a sublist field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @retun {nlobjSubrecord}
+ *
+ * @since 2011.2
+ */
+function nlapiViewCurrentLineItemSubrecord(type,fldnam) { ; }
+
+
+/**
+ * view a subrecord on a sublist field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	type sublist name
+ * @param {string} 	fldnam sublist field name
+ * @retun {nlobjSubrecord}
+ *
+ * @since 2011.2
+ */
+function nlapiViewLineItemSubrecord(type,fldnam,linenum) { ; }
+
+/**
+ * create a subrecord on body field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	fldnam body field name
+ * @retun {nlobjSubrecord}
+ *
+ * @since 2011.2
+ */
+function createSubrecord(fldnam) { ; }
+
+/**
+ * edit a subrecord on body field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	fldnam body field name
+ * @retun {nlobjSubrecord}
+ *
+ * @since 2011.2
+ */
+function editSubrecord(fldnam) { ; }
+
+/**
+ * remove a subrecord on body field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	fldnam body field name
+ * @retun {void}
+ *
+ * @since 2011.2
+ */
+function removeSubrecord(fldnam) { ; }
+
+/**
+ * view a subrecord on body field on the current record on a page.
+ * @restriction supported in client and user event scripts only.
+ * @param {string} 	fldnam body field name
+ * @retun {nlobjSubrecord}
+ *
+ * @since 2011.2
+ */
+function viewSubrecord(fldnam) { ; }
+
+
+/**
+ * Commit the subrecord after you finish modifying it.
+ *
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjSubrecord
+ *
+ * @since 2008.1
+ */
+nlobjSubrecord.prototype.commit = function() { ; }
+
+/**
+ * Cancel the any modification on subrecord.
+ *
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjSubrecord
+ *
+ * @since 2008.1
+ */
+nlobjSubrecord.prototype.cancel = function() { ; }
+
+/**
+ * Return a new instance of nlobjRecord used for accessing and manipulating record objects.
+ *
+ * @classDescription Class definition for business records in the system.
+ * @return {nlobjRecord}
+ * @constructor
+ *
+ * @since 2008.2
+ */
+function nlobjRecord() { ; }
+
+/**
+ * Return the internalId of the record or NULL for new records.
+ *
+ * @return {int} Return the integer value of the record ID.
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.1
+ */
+nlobjRecord.prototype.getId = function() { ; }
+
+/**
+ * Return the recordType corresponding to this record.
+ *
+ * @return {string} The string value of the record name internal ID
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.1
+ */
+nlobjRecord.prototype.getRecordType = function( ) { ; }
+
+/**
+ * Return field metadata for field.
+ *
+ * @param {string} fldnam field name
+ * @return	{nlobjField}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.1
+ */
+nlobjRecord.prototype.getField = function(fldnam) { ; }
+
+/**
+ * Return sublist metadata for sublist.
+ *
+ * @param {string} type sublist name
+ * @return {nlobjSubList}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.getSubList = function(type) { ; }
+
+/**
+ * Return field metadata for field.
+ *
+ * @param {string} type matrix sublist name
+ * @param {string} fldnam matrix field name
+ * @param {column} linenum matrix column (1-based)
+ * @return {nlobjField}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.getMatrixField = function(type, fldnam, column) { ; }
+
+/**
+ * Return metadata for sublist field.
+ *
+ * @param {string} type sublist name
+ * @param {string} fldnam sublist field name
+ * @param {int} [linenum] line number (1-based). If empty, the current sublist field is returned. only settable for sublists of type list
+ * @return {nlobjField}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.getLineItemField = function(type, fldnam, linenum) { ; }
+
+/**
+ * Return metadata for sublist field.
+ *
+ * @param {string} type matrix sublist name
+ * @param {string} fldnam matrix field name
+ * @param {int} linenum line number
+ * @param {column} linenum matrix column (1-based)
+ * @return {nlobjField}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.getLineItemMatrixField = function(type, fldnam, linenum, column) { ; }
+
+/**
+ * Set the value of a field.
+ *
+ * @param {string} name field name
+ * @param {string} value field value
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.1
+ */
+nlobjRecord.prototype.setFieldValue = function( name, value ) { ; }
+
+/**
+ * Set the values of a multi-select field.
+ *
+ * @param {string} name field name
+ * @param {string[]} values string array containing field values
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.1
+ */
+nlobjRecord.prototype.setFieldValues = function( name, values ) { ; }
+
+/**
+ * Return the value of a field.
+ *
+ * @param {string} name field name
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.1
+ */
+nlobjRecord.prototype.getFieldValue = function( name ) { ; }
+
+/**
+ * Return the selected values of a multi-select field as an Array.
+ *
+ * @param {string} name field name
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.1
+ */
+nlobjRecord.prototype.getFieldValues = function( name ) { ; }
+
+/**
+ * Set the value (via display value) of a select field.
+ * @restriction only supported for select fields
+ *
+ * @param {string} name field name
+ * @param {string} text field display value
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.2
+ */
+nlobjRecord.prototype.setFieldText = function( name, text ) { ; }
+
+/**
+ * Set the values (via display values) of a multi-select field.
+ * @restriction only supported for multi-select fields
+ *
+ * @param {string} name field name
+ * @param {string[]} texts array of field display values
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.2
+ */
+nlobjRecord.prototype.setFieldTexts = function( name, texts ) { ; }
+
+/**
+ * Return the display value for a select field.
+ * @restriction only supported for select fields
+ *
+ * @param {string} name field name
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.2
+ */
+nlobjRecord.prototype.getFieldText = function( name ) { ; }
+
+/**
+ * Return the selected display values of a multi-select field as an Array.
+ * @restriction only supported for multi-select fields
+ *
+ * @param {string} name field name
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.2
+ */
+nlobjRecord.prototype.getFieldTexts = function( name ) { ; }
+
+/**
+ * Get the value of a matrix header field.
+ *
+ * @param {string} type matrix sublist name
+ * @param {string} name	matrix field name
+ * @param {int} column matrix column index (1-based)
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.getMatrixValue = function( type, name, column ) { ; }
+
+/**
+ * Set the value of a matrix header field.
+ *
+ * @param {string} 	type matrix sublist name
+ * @param {string} 	name	matrix field name
+ * @param {int} 	column matrix column index (1-based)
+ * @param {string} 	value field value
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.setMatrixValue = function( type, name, column, value ) { ; }
+
+/**
+ * Return an Array of all field names on the record.
+ *
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.1
+ */
+nlobjRecord.prototype.getAllFields = function( ) { ; }
+
+/**
+ * Return an Array of all field names on a record for a particular sublist.
+ *
+ * @param {string} group sublist name
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.2
+ */
+nlobjRecord.prototype.getAllLineItemFields = function( group ) { ; }
+
+/**
+ * Set the value of a sublist field.
+ *
+ * @param {string} 	group sublist name
+ * @param {string} 	name sublist field name
+ * @param {int} 	line line number (1-based)
+ * @param {string} 	value sublist field value
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.1
+ */
+nlobjRecord.prototype.setLineItemValue = function( group, name, line, value ) { ; }
+
+/**
+ * Return the value of a sublist field.
+ *
+ * @param {string} 	group sublist name
+ * @param {string} 	name sublist field name
+ * @param {int} 	line line number (1-based)
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.1
+ */
+nlobjRecord.prototype.getLineItemValue = function( group, name, line ) { ; }
+
+/**
+ * Return the text value of a sublist field.
+ *
+ * @param {string} 	group sublist name
+ * @param {string} 	name sublist field name
+ * @param {int} 	line line number (1-based)
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2008.2
+ */
+nlobjRecord.prototype.getLineItemText = function( group, name, line ) { ; }
+
+/**
+ * Set the current value of a sublist field.
+ * @param {string} 	group sublist name
+ * @param {string} 	name sublist field name
+ * @param {string} 	value sublist field value
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.setCurrentLineItemValue = function( group, name, value ) { ; }
+
+/**
+ * Return the current value of a sublist field.
+ *
+ * @param {string} 	group sublist name
+ * @param {string} 	name sublist field name
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.getCurrentLineItemValue = function( group, name ) { ; }
+
+/**
+ * Return the current display value of a sublist field.
+ *
+ * @param {string} 	group sublist name
+ * @param {string} 	name sublist field name
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.getCurrentLineItemText = function( group, name ) { ; }
+
+/**
+ * Set the current value of a sublist matrix field.
+ *
+ * @param {string} 	group matrix sublist name
+ * @param {string} 	name matrix field name
+ * @param {int} 	column matrix field column index (1-based)
+ * @param {string} 	value matrix field value
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.setCurrentLineItemMatrixValue = function( group, name, column, value ) { ; }
+
+/**
+ * Return the current value of a sublist matrix field.
+ *
+ * @param {string} 	group matrix sublist name
+ * @param {string} 	name matrix field name
+ * @param {int} 	column matrix field column index (1-based)
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.getCurrentLineItemMatrixValue = function( group, name, column ) { ; }
+
+/**
+ * Return the number of columns for a matrix field.
+ *
+ * @param {string} 	group matrix sublist name
+ * @param {string} 	name matrix field name
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.getMatrixCount = function( group, name ) { ; }
+
+/**
+ * Return the number of lines in a sublist.
+ *
+ * @param {string} group sublist name
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.getLineItemCount = function( group ) { ; }
+
+/**
+ * Return line number for 1st occurence of field value in a sublist column.
+ *
+ * @param {string} group	sublist name
+ * @param {string} fldnam	sublist field name
+ * @param {string} value	sublist field value
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.findLineItemValue = function( group, fldnam, value ) { ; }
+
+/**
+ * Return line number for 1st occurence of field value in a sublist column.
+ *
+ * @param {string} 	group	sublist name
+ * @param {string} 	fldnam	sublist field name
+ * @param {int} 	column  matrix column index (1-based)
+ * @param {string} 	value 	matrix field value
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.findLineItemMatrixValue = function( group, fldnam, column, value ) { ; }
+
+/**
+ * Insert a new line into a sublist.
+ *
+ * @param {string} 	group sublist name
+ * @param {int} 	[line] line index at which to insert line
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.insertLineItem = function( group, line ) { ; }
+
+/**
+ * Remove an existing line from a sublist.
+ *
+ * @param {string} 	group sublist name
+ * @param {int} 	[line] line number to remove
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.removeLineItem = function( group, line ) { ; }
+
+/**
+ * Insert and select a new line in a sublist.
+ *
+ * @param {string} group sublist name
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.selectNewLineItem = function( group ) { ; }
+
+/**
+ * Select an existing line in a sublist.
+ *
+ * @param {string} 	group sublist name
+ * @param {int} 	line  line number to select
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.selectLineItem = function( group, line ) { ; }
+
+/**
+ * Commit the current line in a sublist.
+ *
+ * @param {string} 	group sublist name
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjRecord
+ *
+ * @since 2009.2
+ */
+nlobjRecord.prototype.commitLineItem = function( group ) { ; }
+
+/**
+ * Return a new instance of nlobjConfiguration..
+ *
+ * @classDescription Class definition for interacting with setup/configuration pages
+ * @return {nlobjConfiguration}
+ * @constructor
+ *
+ * @since 2009.2
+ */
+function nlobjConfiguration( ) { ; }
+
+/**
+ * return the type corresponding to this setup record.
+ *
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjConfiguration
+ *
+ * @since 2009.2
+ */
+nlobjConfiguration.prototype.getType = function( ) { ; }
+
+/**
+ * return field metadata for field.
+ *
+ * @param {string} fldnam field name
+ * @return {nlobjField}
+ *
+ * @method
+ * @memberOf nlobjConfiguration
+ *
+ * @since 2009.2
+ */
+nlobjConfiguration.prototype.getField = function(fldnam) { ; }
+
+/**
+ * set the value of a field.
+ *
+ * @param {string} name field name
+ * @param {string} value field value
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjConfiguration
+ *
+ * @since 2009.2
+ */
+nlobjConfiguration.prototype.setFieldValue = function( name, value ) { ; }
+
+/**
+ * Set the values of a multi-select field.
+ * @restriction only supported for multi-select fields
+ *
+ * @param {string} name field name
+ * @param {string[]} value field values
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjConfiguration
+ *
+ * @since 2009.2
+ */
+nlobjConfiguration.prototype.setFieldValues = function( name, value ) { ; }
+
+/**
+ * return the value of a field.
+ *
+ * @param {string} name field name
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjConfiguration
+ *
+ * @since 2009.2
+ */
+nlobjConfiguration.prototype.getFieldValue = function( name ) { ; }
+
+/**
+ * return the selected values of a multi-select field as an Array.
+ * @restriction only supported for multi-select fields
+ *
+ * @param {string} name field name
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjConfiguration
+ *
+ * @since 2009.2
+ */
+nlobjConfiguration.prototype.getFieldValues = function( name ) { ; }
+
+/**
+ * set the value (via display value) of a field.
+ * @restriction only supported for select fields
+ *
+ * @param {string} name field name
+ * @param {string} text field display text
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjConfiguration
+ *
+ * @since 2009.2
+ */
+nlobjConfiguration.prototype.setFieldText = function( name, text ) { ; }
+
+/**
+ * set the values (via display values) of a multi-select field.
+ * @restriction only supported for multi-select fields
+ *
+ * @param {string} 	 name field name
+ * @param {string[]} texts array of field display text values
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjConfiguration
+ *
+ * @since 2009.2
+ */
+nlobjConfiguration.prototype.setFieldTexts = function( name, texts ) { ; }
+
+/**
+ * return the text value of a field.
+ * @restriction only supported for select fields
+ *
+ * @param {string} name field name
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjConfiguration
+ *
+ * @since 2009.2
+ */
+nlobjConfiguration.prototype.getFieldText = function( name ) { ; }
+
+/**
+ * return the selected text values of a multi-select field as an Array.
+ * @param {string} name field name
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjConfiguration
+ *
+ * @since 2009.2
+ */
+nlobjConfiguration.prototype.getFieldTexts = function( name ) { ; }
+
+/**
+ * return an Array of all field names on the record.
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjConfiguration
+ *
+ * @since 2009.2
+ */
+nlobjConfiguration.prototype.getAllFields = function( ) { ; }
+
+/**
+ * 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
+ */
+function nlobjFile( ) { ; }
+
+/**
+ * Return the name of the file.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.getName = function( ) { ; }
+
+/**
+ * Sets the name of a file.
+ * @param {string} name the name of the file
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.setName = function( name ) { ; }
+
+/**
+ * return the internal ID of the folder that this file is in.
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.getFolder = function( ) { ; }
+
+/**
+ * sets the internal ID of the folder that this file is in.
+ * @param {int} folder
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.setFolder = function( folder ) { ; }
+
+/**
+ * sets the character encoding for the file.
+ * @param {String} encoding
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2010.2
+ */
+nlobjFile.prototype.setEncoding = function( encoding ) { ; }
+
+/**
+ * return true if the file is "Available without Login".
+ * @return {boolean}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.isOnline = function( ) { ; }
+
+/**
+ * sets the file's "Available without Login" status.
+ * @param {boolean} online
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.setIsOnline = function( online ) { ; }
+
+/**
+ * return true if the file is inactive.
+ * @return {boolean}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.isInactive = function( ) { ; }
+
+/**
+ * sets the file's inactive status.
+ * @param {boolean} inactive
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.setIsInactive = function( inactive ) { ; }
+
+/**
+ * return the file description.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.getDescription = function( ) { ; }
+
+/**
+ * sets the file's description.
+ * @param {string} descr the file description
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.setDescription = function( descr ) { ; }
+
+/**
+ * Return the id of the file (if stored in the FC).
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.getId = function( ) { ; }
+
+/**
+ * Return the size of the file in bytes.
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.getSize = function( ) { ; }
+
+/**
+ * Return the URL of the file (if stored in the FC).
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.getURL = function( ) { ; }
+
+/**
+ * Return the type of the file.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.getType = function( ) { ; }
+
+/**
+ * Return the value (base64 encoded for binary types) of the file.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjFile
+ *
+ * @since 2009.1
+ */
+nlobjFile.prototype.getValue = function( ) { ; }
+
+/**
+ * Return a new instance of nlobjSearchFilter filter objects used to define search criteria.
+ *
+ * @classDescription search filter
+ * @constructor
+ * @param {string} name filter name.
+ * @param {string} join internal ID for joined search where this filter is defined
+ * @param {string} operator operator name (i.e. anyOf, contains, lessThan, etc..)
+ * @param {string|string[]} value
+ * @param {string} value2
+ * @return {nlobjSearchFilter}
+ *
+ * @since 2007.0
+ */
+function nlobjSearchFilter( name, join, operator, value, value2 ) { ; }
+
+/**
+ * Return the name of this search filter.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchFilter
+ *
+ * @since 2007.0
+ */
+nlobjSearchFilter.prototype.getName = function( ) { ; }
+
+/**
+ * Return the join id for this search filter.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchFilter
+ *
+ * @since 2008.1
+ */
+nlobjSearchFilter.prototype.getJoin = function( ) { ; }
+
+/**
+ * Return the filter operator used.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchFilter
+ *
+ * @since 2008.2
+ */
+nlobjSearchFilter.prototype.getOperator = function( ) { ; }
+
+/**
+ * Return a new instance of nlobjSearchColumn used for column objects used to define search return columns.
+ *
+ * @classDescription search column.
+ * @return {nlobjSearchColumn}
+ * @constructor
+ * @param {string} name column name.
+ * @param {string} join internal ID for joined search where this column is defined
+ * @param {string} summary
+ *
+ * @since 2007.0
+ */
+function nlobjSearchColumn( name, join, summary ) { ; }
+
+/**
+ * return the name of this search column.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchColumn
+ * @since 2008.1
+ */
+nlobjSearchColumn.prototype.getName = function( ) { ; }
+
+/**
+ * return the join id for this search column.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchColumn
+ * @since 2008.1
+ */
+nlobjSearchColumn.prototype.getJoin = function( ) { ; }
+
+/**
+ * return the label of this search column.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchColumn
+ *
+ * @since 2009.1
+ */
+nlobjSearchColumn.prototype.getLabel = function( ) { ; }
+
+/**
+ * return the summary type (avg,group,sum,count) of this search column.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchColumn
+ * @since 2008.1
+ */
+nlobjSearchColumn.prototype.getSummary = function( ) { ; }
+
+/**
+ * return formula for this search column.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchColumn
+ *
+ * @since 2009.2
+ */
+nlobjSearchColumn.prototype.getFormula = function( ) { ; }
+
+/**
+ * return nlobjSearchColumn sorted in either ascending or descending order.
+ * @return {nlobjSearchColumn}
+ * @param {boolean} sort if not set, defaults to false, which returns column data in ascending order.
+ *
+ * @method
+ * @memberOf nlobjSearchColumn
+ *
+ * @since 2010.1
+ */
+nlobjSearchColumn.prototype.setSort = function( order ) { ; }
+
+/**
+ * Return a new instance of nlobjSearchResult used for search result row object.
+ *
+ * @classDescription Class definition for interacting with the results of a search operation
+ * @return {nlobjSearchResult}
+ * @constructor
+ */
+function nlobjSearchResult( ) { ; }
+
+/**
+ * return the internalId for the record returned in this row.
+ * @method
+ * @memberOf nlobjSearchResult
+ * @return {int}
+ */
+nlobjSearchResult.prototype.getId = function( ) { ; }
+
+/**
+ * return the recordtype for the record returned in this row.
+ * @method
+ * @memberOf nlobjSearchResult
+ * @return {string}
+ */
+nlobjSearchResult.prototype.getRecordType = function( ) { ; }
+
+/**
+ * return the value for this nlobjSearchColumn.
+ * @param {nlobjSearchColumn} column search result column
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchResult
+ *
+ * @since 2009.1
+ */
+nlobjSearchResult.prototype.getValue = function( column ) { ; }
+
+/**
+ * return the value for a return column specified by name, join ID, and summary type.
+ * @param {string} name the name of the search column
+ * @param {string} join the join ID for the search column
+ * @param {string} summary summary type specified for this column
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchResult
+ *
+ * @since 2008.1
+ */
+nlobjSearchResult.prototype.getValue = function( name, join, summary ) { ; }
+
+/**
+ * return the text value for this nlobjSearchColumn if it's a select field.
+ * @param {nlobjSearchColumn} column search result column
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchResult
+ *
+ * @since 2009.1
+ */
+nlobjSearchResult.prototype.getText = function( column ) { ; }
+
+/**
+ * return the text value of this return column if it's a select field.
+ * @param {string} name the name of the search column
+ * @param {string} join the join ID for the search column
+ * @param {string} summary summary type specified for this column
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSearchResult
+ *
+ * @since 2008.1
+ */
+nlobjSearchResult.prototype.getText = function( name, join, summary ) { ; }
+
+/**
+ * return an array of all nlobjSearchColumn objects returned in this search.
+ * @return {nlobjSearchColumn[]}
+ *
+ * @method
+ * @memberOf nlobjSearchResult
+ *
+ * @since 2009.2
+ */
+nlobjSearchResult.prototype.getAllColumns = function( ) { ; }
+
+/**
+ * Return a new instance of nlobjContext used for user and script context information.
+ *
+ * @classDescription Utility class providing information about the current user and the script runtime.
+ * @return {nlobjContext}
+ * @constructor
+ */
+function nlobjContext( ) { ; }
+/**
+ * return the name of the current user.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2007.0
+ */
+nlobjContext.prototype.getName = function( ) { ; }
+
+/**
+ * return the internalId of the current user.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2007.0
+ */
+nlobjContext.prototype.getUser = function( ) { ; }
+
+/**
+ * return the internalId of the current user's role.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2007.0
+ */
+nlobjContext.prototype.getRole = function( ) { ; }
+
+/**
+ * return the script ID of the current user's role.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2008.2
+ */
+nlobjContext.prototype.getRoleId = function( ) { ; }
+
+/**
+ * return the internalId of the current user's center type.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2008.2
+ */
+nlobjContext.prototype.getRoleCenter = function( ) { ; }
+
+/**
+ * return the email address of the current user.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2007.0
+ */
+nlobjContext.prototype.getEmail = function( ) { ; }
+
+/**
+ * return the internal ID of the contact logged in on behalf of a customer, vendor, or partner. It returns -1 for non-contact logins
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.1
+ */
+nlobjContext.prototype.getContact = function( ) { ; }
+
+/**
+ * return the account ID of the current user.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2007.0
+ */
+nlobjContext.prototype.getCompany = function( ) { ; }
+
+/**
+ * return the internalId of the current user's department.
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2007.0
+ */
+nlobjContext.prototype.getDepartment = function( ) { ; }
+
+/**
+ * return the internalId of the current user's location.
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2007.0
+ */
+nlobjContext.prototype.getLocation = function( ) { ; }
+
+/**
+ * return the internalId of the current user's subsidiary.
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2007.0
+ */
+nlobjContext.prototype.getSubsidiary = function( ) { ; }
+
+/**
+ * return the execution context for this script: webServices|csvImport|client|userInterface|scheduledScript|portlet|suitelet|debugger|custommassupdate
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2007.0
+ */
+nlobjContext.prototype.getExecutionContext = function( ) { ; }
+
+/**
+ * return the amount of usage units remaining for this script.
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2007.0
+ */
+nlobjContext.prototype.getRemainingUsage = function( ) { ; }
+
+/**
+ * return true if feature is enabled, false otherwise
+ * @param {string} name
+ * @return {boolean}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.2
+ */
+nlobjContext.prototype.getFeature = function( name ) { ; }
+
+/**
+ * return current user's permission level (0-4) for this permission
+ * @param {string} name
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.2
+ */
+nlobjContext.prototype.getPermission = function( name ) { ; }
+
+/**
+ * return system or script preference selection for current user
+ * @param {string} name
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.2
+ */
+nlobjContext.prototype.getPreference = function( name ) { ; }
+
+/**
+ * return value of session object set by script
+ * @param {string} name
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.2
+ */
+nlobjContext.prototype.getSessionObject = function( name ) { ; }
+
+/**
+ * set the value of a session object using a key.
+ * @param {string} name
+ * @param {string} value
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.2
+ */
+nlobjContext.prototype.setSessionObject = function( name, value ) { ; }
+
+/**
+ * return an array containing the names of all keys used to set session objects
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.2
+ */
+nlobjContext.prototype.getAllSessionObjects = function() { ; }
+
+/**
+ * return the NetSuite version for the current account
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.2
+ */
+nlobjContext.prototype.getVersion = function(  ) { ; }
+
+/**
+ * return the environment that the script is executing in: SANDBOX, PRODUCTION, BETA, INTERNAL
+ * @since 2008.2
+ */
+nlobjContext.prototype.getEnvironment = function(  ) { ; }
+
+/**
+ * return the logging level for the current script execution. Not supported in CLIENT scripts
+ * @since 2008.2
+ */
+nlobjContext.prototype.getLogLevel = function(  ) { ; }
+
+/**
+ * return the script ID for the current script
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.2
+ */
+nlobjContext.prototype.getScriptId = function(  ) { ; }
+
+/**
+ * return the deployment ID for the current script
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.2
+ */
+nlobjContext.prototype.getDeploymentId = function(  ) { ; }
+
+/**
+ * return the % complete specified for the current scheduled script execution
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.2
+ */
+nlobjContext.prototype.getPercentComplete = function(  ) { ; }
+
+/**
+ * set the % complete for the current scheduled script execution
+ * @param {float} ct the percentage of records completed
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2009.2
+ */
+nlobjContext.prototype.setPercentComplete = function( pct ) { ; }
+
+/**
+ * return a system/script setting. Types are SCRIPT, SESSION, FEATURE, PERMISSION
+ *
+ * @param {string} type
+ * @param {string} name
+ * @since 2007.0
+ * @deprecated
+ */
+nlobjContext.prototype.getSetting = function( type, name ) { ; }
+
+/**
+ * set a system/script setting. Only supported type is SESSION
+ *
+ * @param {string} type
+ * @param {string} name
+ * @param {string} value
+ * @since 2007.0
+ * @deprecated
+ */
+nlobjContext.prototype.setSetting = function( type, name, value ) { ; }
+
+/**
+ * return an Object containing name/value pairs of color groups to their corresponding RGB hex color based on the currenly logged in user's color them preferences.
+ * @return {Object}
+ *
+ * @method
+ * @memberOf nlobjContext
+ *
+ * @since 2010.1
+ */
+nlobjContext.prototype.getColorPreferences = function() { ; }
+
+/**
+ * Return a new instance of nlobjError used system or user-defined error object.
+ *
+ * @classDescription Encapsulation of errors thrown during script execution.
+ * @return {nlobjError}
+ * @constructor
+ */
+function nlobjError( ) { ; }
+
+/**
+ * return the error db ID for this error (if it was an unhandled unexpected error).
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjError
+ *
+ * @since 2008.2
+ */
+nlobjError.prototype.getId = function( ) { ; }
+
+/**
+ * return the error code for this system or user-defined error.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjError
+ *
+ * @since 2008.2
+ */
+nlobjError.prototype.getCode = function( ) { ; }
+
+/**
+ * return the error description for this error.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjError
+ *
+ * @since 2008.2
+ */
+nlobjError.prototype.getDetails = function( ) { ; }
+
+/**
+ * return a stacktrace containing the location of the error.
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjError
+ *
+ * @since 2008.2
+ */
+nlobjError.prototype.getStackTrace = function( ) { ; }
+
+/**
+ * return the userevent script name where this error was thrown.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjError
+ *
+ * @since 2008.2
+ */
+nlobjError.prototype.getUserEvent = function( ) { ; }
+
+/**
+ * return the internalid of the record if this error was thrown in an aftersubmit script.
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjError
+ *
+ * @since 2008.2
+ */
+nlobjError.prototype.getInternalId = function( ) { ; }
+
+/**
+ * Return a new instance of nlobjServerResponse..
+ *
+ * @classDescription Contains the results of a server response to an outbound Http(s) call.
+ * @return {nlobjServerResponse}
+ * @constructor
+ *
+ * @since 2008.1
+ */
+function nlobjServerResponse( ) { ; }
+
+/**
+ * return the Content-Type header in response
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjServerResponse
+ *
+ * @since 2008.1
+ */
+nlobjServerResponse.prototype.getContentType = function( ) { ; }
+
+/**
+ * return the value of a header returned.
+ * @param {string} name the name of the header to return
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjServerResponse
+ *
+ * @since 2008.1
+ */
+nlobjServerResponse.prototype.getHeader = function(name) { ; }
+
+/**
+ * return all the values of a header returned.
+ * @param {string} name the name of the header to return
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjServerResponse
+ *
+ * @since 2008.1
+ */
+nlobjServerResponse.prototype.getHeaders = function(name) { ; }
+
+/**
+ * return an Array of all headers returned.
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjServerResponse
+ *
+ * @since 2008.1
+ */
+nlobjServerResponse.prototype.getAllHeaders = function( ) { ; }
+
+/**
+ * return the response code returned.
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjServerResponse
+ *
+ * @since 2008.1
+ */
+nlobjServerResponse.prototype.getCode = function( ) { ; }
+
+/**
+ * return the response body returned.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjServerResponse
+ *
+ * @since 2008.1
+ */
+nlobjServerResponse.prototype.getBody = function( ) { ; }
+
+/**
+ * return the nlobjError thrown via a client call to nlapiRequestURL.
+ * @return {nlobjError}
+ *
+ * @method
+ * @memberOf nlobjServerResponse
+ *
+ * @since 2008.1
+ */
+nlobjServerResponse.prototype.getError = function( ) { ; }
+
+/**
+ * Return a new instance of nlobjResponse used for scripting web responses in Suitelets
+ *
+ * @classDescription Accessor to Http response made available to Suitelets.
+ * @return {nlobjResponse}
+ * @constructor
+ */
+function nlobjResponse( ) { ; }
+
+/**
+ * add a value for a response header.
+ * @param  {string} name of header
+ * @param  {string} value for header
+ * @return  {void}
+ *
+ * @method
+ * @memberOf nlobjResponse
+ *
+ * @since 2008.2
+ */
+nlobjResponse.prototype.addHeader = function( name, value ) { ; }
+
+/**
+ * set the value of a response header.
+ * @param  {string} name of header
+ * @param  {string} value for header
+ * @return  {void}
+ *
+ * @method
+ * @memberOf nlobjResponse
+ *
+ * @since 2008.2
+ */
+nlobjResponse.prototype.setHeader = function( name, value ) { ; }
+
+/**
+ * return the value of a response header.
+ * @param  {string} name of header
+ * @return  {string}
+ *
+ * @method
+ * @memberOf nlobjResponse
+ *
+ * @since 2008.2
+ */
+nlobjResponse.prototype.getHeader = function( ) { ; }
+
+/**
+ * return an Array of all response header values for a header
+ * @param  {string} name of header
+ * @return  {string[]}
+ *
+ * @method
+ * @memberOf nlobjResponse
+ *
+ * @since 2008.2
+ */
+nlobjResponse.prototype.getHeaders = function( name ) { ; }
+
+/**
+ * return an Array of all response headers
+ * @return  {Object}
+ *
+ * @method
+ * @memberOf nlobjResponse
+ *
+ * @since 2008.2
+ */
+nlobjResponse.prototype.getAllHeaders = function( ) { ; }
+
+/**
+ * suppress caching for this response.
+ * @return  {void}
+ *
+ * @method
+ * @memberOf nlobjResponse
+ *
+ * @since 2009.1
+ */
+nlobjResponse.prototype.sendNoCache = function( ) { ; }
+
+/**
+ * sets the content type for the response (and an optional filename for binary output).
+ *
+ * @param {string} type the file type i.e. plainText, word, pdf, htmldoc (see list of media item types)
+ * @param {string} filename the file name
+ * @param {string} disposition Content Disposition used for streaming attachments: inline|attachment
+ * @return {void}
+ * @method
+ * @memberOf nlobjResponse
+ *
+ * @since 2008.2
+ */
+nlobjResponse.prototype.setContentType = function( type, filename, disposition ) { ; }
+
+/**
+ * sets the redirect URL for the response. all URLs must be internal unless the Suitelet is being executed in an "Available without Login" context
+ *  at which point it can use type "external" to specify an external url via the subtype arg
+ *
+ * @param {string} type type specifier for URL: suitelet|tasklink|record|mediaitem|external
+ * @param {string} subtype subtype specifier for URL (corresponding to type): scriptid|taskid|recordtype|mediaid|url
+ * @param {string} [id] internal ID specifier (sub-subtype corresponding to type): deploymentid|n/a|recordid|n/a
+ * @param {string} [pagemode] string specifier used to configure page (suitelet: external|internal, tasklink|record: edit|view)
+ * @param {Object} [parameters] Object used to specify additional URL parameters as name/value pairs
+ * @return {void}
+ * @method
+ * @memberOf nlobjResponse
+ *
+ * @since 2008.2
+ */
+nlobjResponse.prototype.sendRedirect = function( type, subtype, id, pagemode, parameters ) { ; }
+
+/**
+ * write information (text/xml/html) to the response.
+ *
+ * @param {string} output
+ * @return {void}
+ * @method
+ * @memberOf nlobjResponse
+ *
+ * @since 2008.2
+ */
+nlobjResponse.prototype.write = function( output ) { ; }
+
+/**
+ * write line information (text/xml/html) to the response.
+ *
+ * @param {string} output
+ * @return {void}
+ * @method
+ * @memberOf nlobjResponse
+ *
+ * @since 2008.2
+ */
+nlobjResponse.prototype.writeLine = function( output ) { ; }
+
+/**
+ * write a UI object page.
+ *
+ * @param {Object} pageobject page UI object: nlobjList|nlobjAssistant|nlobjForm|nlobjDashboard
+ * @return {void}
+ * @method
+ * @memberOf nlobjResponse
+ *
+ * @since 2008.2
+ */
+nlobjResponse.prototype.writePage = function( pageobject ) { ; }
+
+/**
+ * Return a new instance of nlobjRequest used for scripting web requests in Suitelets
+ *
+ * @classDescription Accessor to Http request data made available to Suitelets
+ * @return {nlobjRequest}
+ * @constructor
+ */
+function nlobjRequest( ) { ; }
+
+/**
+ * return the value of a request parameter.
+ *
+ * @param {string} name parameter name
+ * @return {string}
+ * @method
+ * @memberOf nlobjRequest
+ *
+ * @since 2008.2
+ */
+nlobjRequest.prototype.getParameter = function( name ) { ; }
+
+/**
+ * return the values of a request parameter as an Array.
+ *
+ * @param {string} name parameter name
+ * @return {string[]}
+ * @method
+ * @memberOf nlobjRequest
+ *
+ * @since 2008.2
+ */
+nlobjRequest.prototype.getParameterValues = function( name ) { ; }
+
+/**
+ * return an Object containing all the request parameters and their values.
+ * @return {Object}
+ * @method
+ * @memberOf nlobjRequest
+ *
+ * @since 2008.2
+ */
+nlobjRequest.prototype.getAllParameters = function( ) { ; }
+
+/**
+ * return the value of a sublist value.
+ * @param {string} 	group sublist name
+ * @param {string} 	name  sublist field name
+ * @param {int} 	line  sublist line number
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRequest
+ *
+ * @since 2008.2
+ */
+nlobjRequest.prototype.getLineItemValue = function( group, name, line ) { ; }
+
+/**
+ * return the number of lines in a sublist.
+ * @param {string} group sublist name
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjRequest
+ *
+ * @since 2008.2
+ */
+nlobjRequest.prototype.getLineItemCount = function( group ) { ; }
+
+/**
+ * return the value of a request header.
+ * @param {string} name
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRequest
+ *
+ * @since 2008.2
+ */
+nlobjRequest.prototype.getHeader = function( name ) { ; }
+
+/**
+ * return an Object containing all the request headers and their values.
+ * @return {Object}
+ *
+ * @method
+ * @memberOf nlobjRequest
+ *
+ * @since 2008.2
+ */
+nlobjRequest.prototype.getAllHeaders = function( ) { ; }
+
+/**
+ * return the value of an uploaded file.
+ * @param {string} name file field name
+ * @return {nlobjFile}
+ *
+ * @method
+ * @memberOf nlobjRequest
+ *
+ * @since 2009.1
+ */
+nlobjRequest.prototype.getFile = function( name ) { ; }
+
+/**
+ * return an Object containing field names to file objects for all uploaded files.
+ * @return {Object}
+ *
+ * @method
+ * @memberOf nlobjRequest
+ *
+ * @since 2009.1
+ */
+nlobjRequest.prototype.getAllFiles = function( ) { ; }
+
+/**
+ * return the body of the POST request
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRequest
+ * @since 2008.1
+ */
+nlobjRequest.prototype.getBody = function( ) { ; }
+
+/**
+ * return the URL of the request
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRequest
+ * @since 2008.1
+ */
+nlobjRequest.prototype.getURL = function( ) { ; }
+
+/**
+ * return the METHOD of the request
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjRequest
+ * @since 2008.1
+ */
+nlobjRequest.prototype.getMethod = function( ) { ; }
+
+/**
+ * Return a new instance of nlobjPortlet used for scriptable dashboard portlet.
+ *
+ * @classDescription UI Object used for building portlets that are displayed on dashboard pages
+ * @return {nlobjPortlet}
+ * @constructor
+ */
+function nlobjPortlet( ) { ; }
+
+/**
+ * set the portlet title.
+ *
+ * @param {string} title
+ * @since 2008.2
+ */
+nlobjPortlet.prototype.setTitle = function( title ) { ; }
+
+/**
+ * set the entire contents of the HTML portlet (will be placed inside a <TD>...</TD>).
+ *
+ * @param {string} html
+ * @since 2008.2
+ */
+nlobjPortlet.prototype.setHtml = function( html ) { ; }
+
+/**
+ * add a column (nlobjColumn) to this LIST portlet and return it.
+ *
+ * @param {string} name	column name
+ * @param {string} type column type
+ * @param {string} label column label
+ * @param {string} [align] column alignment
+ * @since 2008.2
+ */
+nlobjPortlet.prototype.addColumn = function( name, type, label, align ) { ; }
+
+/**
+ * add an Edit column (nlobjColumn) to the left of the column specified (supported on LIST portlets only).
+ *
+ * @param {nlobjColumn} column
+ * @param {boolean} showView should Edit|View instead of Edit link
+ * @param {string} 	[showHref] column that evaluates to T or F that determines whether to disable the edit|view link per-row.
+ * @return {nlobjColumn}
+ *
+ * @since 2008.2
+ */
+nlobjPortlet.prototype.addEditColumn = function( column, showView, showHref ) { ; }
+
+/**
+ * add a row (nlobjSearchResult or Array of name-value pairs) to this LIST portlet.
+ *
+ * @param {string[]|nlobjSearchResult} row
+ * @since 2008.2
+ */
+nlobjPortlet.prototype.addRow = function( row ) { ; }
+
+/**
+ * add multiple rows (Array of nlobjSearchResults or name-value pair Arrays) to this LIST portlet.
+ *
+ * @param {string[][]|nlobjSearchResult[]} rows
+ * @since 2008.2
+ */
+nlobjPortlet.prototype.addRows = function( rows ) { ; }
+
+/**
+ * add a field (nlobjField) to this FORM portlet and return it.
+ *
+ * @param {string} name field name
+ * @param {string} type field type
+ * @param {string} [label] field label
+ * @param {string, int} [source] script ID or internal ID for source list (select and multiselects only) -or- radio value for radio fields
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjPortlet.prototype.addField = function( name,type,label,source ) { ; }
+
+/**
+ * add a FORM submit button to this FORM portlet.
+ *
+ * @param {string} url	URL that this form portlet will POST to
+ * @param {string} [label] label for submit button (defaults to Save)
+ * @since 2008.2
+ */
+nlobjPortlet.prototype.setSubmitButton = function( url, label ) { ; }
+
+/**
+ * add a line (containing text or simple HTML) with optional indenting and URL to this LINKS portlet.
+ *
+ * @param {string} 	text data to output to line
+ * @param {string} 	[url] URL if this line should be clickable (if NULL then line will not be clickable)
+ * @param {int} 	indent # of indents to insert before text
+ * @since 2008.2
+ */
+nlobjPortlet.prototype.addLine = function( text, url, indent ) { ; }
+
+/**
+ * Return a new instance of nlobjList used for scriptable list page.
+ *
+ * @classDescription UI Object page type used for building lists
+ * @return {nlobjList}
+ * @constructor
+ */
+function nlobjList( ) { ; }
+
+/**
+ * set the page title.
+ *
+ * @param {string} title
+ * @since 2008.2
+ */
+nlobjList.prototype.setTitle = function( title ) { ; }
+
+/**
+ * set the global style for this list: grid|report|plain|normal.
+ *
+ * @param {string} style overall style used to render list
+ * @since 2008.2
+ */
+nlobjList.prototype.setStyle = function( style ) { ; }
+
+/**
+ * set the Client SuiteScript used for this page.
+ *
+ * @param {string, int} script script ID or internal ID for global client script used to enable Client SuiteScript on page
+ * @since 2008.2
+ */
+nlobjList.prototype.setScript = function( script ) { ; }
+
+/**
+ * add a column (nlobjColumn) to this list and return it.
+ *
+ * @param {string} name column name
+ * @param {string} type column type
+ * @param {string} label column label
+ * @param {string} [align] column alignment
+ * @return {nlobjColumn}
+ *
+ * @since 2008.2
+ */
+nlobjList.prototype.addColumn = function( name, type, label, align ) { ; }
+
+/**
+ * add an Edit column (nlobjColumn) to the left of the column specified.
+ *
+ * @param {nlobjColumn} column
+ * @param {boolean} showView should Edit|View instead of Edit link
+ * @param {string} 	[showHref] column that evaluates to T or F that determines whether to disable the edit|view link per-row.
+ * @return {nlobjColumn}
+ *
+ * @since 2008.2
+ */
+nlobjList.prototype.addEditColumn = function( column, showView, showHref ) { ; }
+
+/**
+ * add a row (Array of name-value pairs or nlobjSearchResult) to this portlet.
+ *
+ * @param {string[], nlobjSearchResult} row data used to add a single row
+ * @since 2008.2
+ */
+nlobjList.prototype.addRow = function( row ) { ; }
+
+/**
+ * add multiple rows (Array of nlobjSearchResults or name-value pair Arrays) to this portlet.
+ *
+ * @param {string[][], nlobjSearchResult[]} rows data used to add multiple rows
+ * @since 2008.2
+ */
+nlobjList.prototype.addRows = function( rows ) { ; }
+
+/**
+ * add a button (nlobjButton) to the footer of this page.
+ *
+ * @param {string} name button name
+ * @param {string} label button label
+ * @param {string} script button script (function name)
+ * @since 2008.2
+ */
+nlobjList.prototype.addButton = function( name, label, script ) { ; }
+
+/**
+ * add a navigation cross-link to the page.
+ *
+ * @param {string} type	page link type: crosslink|breadcrumb
+ * @param {string} title page link title
+ * @param {string} url URL for page link
+ * @since 2008.2
+ */
+nlobjList.prototype.addPageLink = function( type, title, url ) { ; }
+
+/**
+ * Return a new instance of nlobjForm used for scriptable form page.
+ *
+ * @classDescription UI Object page type used for building basic data entry forms.
+ * @return {nlobjForm}
+ * @constructor
+ */
+function nlobjForm( ) { ; }
+
+/**
+ * set the page title.
+ *
+ * @param {string} title
+ * @since 2008.2
+ */
+nlobjForm.prototype.setTitle = function( title ) { ; }
+
+/**
+ * set additional title Html. INTERNAL ONLY
+ *
+ * @param {string} title
+ * @since 2008.2
+ */
+nlobjForm.prototype.addTitleHtml = function( html ) { ; }
+
+/**
+ * set the Client Script definition used for this page.
+ *
+ * @param {string, int} script script ID or internal ID for global client script used to enable Client SuiteScript on page
+ * @since 2008.2
+ */
+nlobjForm.prototype.setScript = function( script ) { ; }
+
+/**
+ * set the values for all the fields on this form.
+ *
+ * @param {Object} values Object containing field name/value pairs
+ * @since 2008.2
+ */
+nlobjForm.prototype.setFieldValues = function( values ) { ; }
+
+/**
+ * add a navigation cross-link to the page.
+ *
+ * @param {string} type	page link type: crosslink|breadcrumb
+ * @param {string} title page link title
+ * @param {string} url URL for page link
+ * @since 2008.2
+ */
+nlobjForm.prototype.addPageLink = function( type, title, url ) { ; }
+
+/**
+ * add a button to this form.
+ *
+ * @param {string} name button name
+ * @param {string} label button label
+ * @param {string} script button script (function name)
+ * @return {nlobjButton}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.addButton = function( name, label, script ) { ; }
+
+/**
+ * get a button from this form by name.
+ * @param {string} name
+ * @return {nlobjButton}
+ *
+ * @method
+ * @memberOf nlobjForm
+ *
+ * @since 2009.2                                                                           add
+ */
+nlobjForm.prototype.getButton = function( name ) { ; }
+
+/**
+ * add a reset button to this form.
+ *
+ * @param {string} [label] label for this button. defaults to "Reset"
+ * @return {nlobjButton}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.addResetButton = function( label ) { ; }
+
+/**
+ * add a submit button to this form.
+ *
+ * @param {string} [label] label for this submit button. defaults to "Save"
+ * @return {nlobjButton}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.addSubmitButton = function( label ) { ; }
+
+/**
+ * add a tab (nlobjTab) to this form and return it.
+ *
+ * @param {string} name tab name
+ * @param {string} label tab label
+ * @return {nlobjTab}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.addTab = function( name, label ) { ; }
+
+/**
+ * add a field (nlobjField) to this form and return it.
+ *
+ * @param {string} name field name
+ * @param {string} type field type
+ * @param {string} [label] field label
+ * @param {string, int} [source] script ID or internal ID for source list (select and multiselects only) -or- radio value for radio fields
+ * @param {string} [tab] tab name that this field will live on. If empty then the field is added to the main section of the form (immediately below the title bar)
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.addField = function( name,type,label,sourceOrRadio,tab ) { ; }
+
+/**
+ * add a subtab (nlobjTab) to this form and return it.
+ *
+ * @param {string} name subtab name
+ * @param {string} label subtab label
+ * @param {string} [tab] parent tab that this subtab lives on. If empty, it is added to the main tab.
+ * @return {nlobjTab}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.addSubTab = function( name,label,tab ) { ; }
+
+/**
+ * add a sublist (nlobjSubList) to this form and return it.
+ *
+ * @param {string} name sublist name
+ * @param {string} type sublist type: inlineeditor|editor|list|staticlist
+ * @param {string} label sublist label
+ * @param {string} [tab] parent tab that this sublist lives on. If empty, it is added to the main tab
+ * @return {nlobjSubList}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.addSubList = function( name,type,label,tab ) { ; }
+
+/**
+ * insert a tab (nlobjTab) before another tab (name).
+ *
+ * @param {nlobjTab} 		tab the tab object to insert
+ * @param {string} 		nexttab the name of the tab before which to insert this tab
+ * @return {nlobjTab}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.insertTab = function( tab, nexttab ) { ; }
+
+/**
+ * insert a field (nlobjField) before another field (name).
+ *
+ * @param {nlobjField} 	field the field object to insert
+ * @param {string} 		nextfld the name of the field before which to insert this field
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.insertField = function( field, nextfld ) { ; }
+
+/**
+ * insert a subtab (nlobjTab) before another subtab or sublist (name).
+ *
+ * @param {nlobjTab}	subtab the subtab object to insert
+ * @param {string} 	nextsubtab the name of the subtab before which to insert this subtab
+ * @return {nlobjTab}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.insertSubTab = function( subtab, nextsubtab ) { ; }
+
+/**
+ * insert a sublist (nlobjSubList) before another subtab or sublist (name).
+ *
+ * @param {nlobjSubList}	sublist the sublist object to insert
+ * @param {string} 		nextsublist the name of the sublist before which to insert this sublist
+ * @return {nlobjSubList}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.insertSubList = function( sublist, nextsublist ) { ; }
+
+/**
+ * return a tab (nlobjTab) on this form.
+ *
+ * @param {string} name tab name
+ * @return {nlobjTab}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.getTab = function( name ) { ; }
+
+/**
+ * return a field (nlobjField) on this form.
+ *
+ * @param {string} name field name
+ * @param {string} [radio] if this is a radio field, specify which radio field to return based on radio value
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.getField = function( name, radio ) { ; }
+
+/**
+ * return a subtab (nlobjTab) on this form.
+ *
+ * @param {string} name subtab name
+ * @return {nlobjTab}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.getSubTab = function( name ) { ; }
+
+/**
+ * return a sublist (nlobjSubList) on this form.
+ *
+ * @param {string} name sublist name
+ * @return {nlobjSubList}
+ *
+ * @since 2008.2
+ */
+nlobjForm.prototype.getSubList = function( name ) { ; }
+
+/**
+ * add a field group to the form.
+ * @param {string} name field group name
+ * @param {string} label field group label
+ * @param tab
+ * @return {nlobjFieldGroup}
+ *
+ * @method
+ * @memberOf nlobjForm
+ *
+ * @since 2011.1
+ */
+nlobjForm.prototype.addFieldGroup = function( name, label, tab ) { ; }
+
+/**
+ * Return a new instance of nlobjAssistant.
+ *
+ * @classDescription UI Object page type used to build multi-step "assistant" pages to simplify complex workflows. All data and state for an assistant is tracked automatically
+ * throughout the user's session up until completion of the assistant.
+ *
+ * @return {nlobjAssistant}
+ * @constructor
+ *
+ * @since 2009.2
+ */
+function nlobjAssistant( ) { ; }
+/**
+ * set the page title.
+ * @param {string} title
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.setTitle = function( title ) { ; }
+
+/**
+ * set the script ID for Client Script used for this form.
+ * @param {string, int} script script ID or internal ID for global client script used to enable Client SuiteScript on page
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.setScript = function( script ) { ; }
+
+/**
+ * set the splash screen used for this page.
+ * @param {string} title splash portlet title
+ * @param {string} text1 splash portlet content (left side)
+ * @param {string} [text2] splash portlet content (right side)
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.setSplash = function( title, text1, text2 ) { ; }
+
+/**
+ * show/hide shortcut link. Always hidden on external pages
+ * @param {boolean} show enable/disable "Add To Shortcut" link on this page
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.setShortcut = function(show) { ; }
+
+/**
+ * set the values for all the fields on this page.
+ * @param {Object} values Object of field name/value pairs used to set all fields on page
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.setFieldValues = function( values ) { ; }
+
+/**
+ * if ordered, steps are show on left and must be completed sequentially, otherwise steps are shown on top and can be done in any order
+ * @param {boolean} ordered	If true (default assistant behavior) then a navigation order thru the steps/pages will be imposed on the user. Otherwise the user
+ * 							will be allowed to navigate across steps/pages in any order they choose.
+ * @return  {void}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.setOrdered = function(ordered) { ; }
+
+/**
+ * if numbered, step numbers are displayed next to the step's label in the navigation area
+ * @param {boolean} numbered	If true (default assistant behavior) step numbers will be displayed next to the step label
+ * @return  {void}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.setNumbered = function(numbered) { ; }
+
+/**
+ * return true if all the steps have been completed.
+ * @return {boolean}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.isFinished = function( ) { ; }
+
+/**
+ * mark assistant page as completed and optionally set the rich text to display on completed page.
+ * @param {string} html completion message (rich text) to display on the "Finish" page
+ * @return  {void}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.setFinished = function( html ) { ; }
+
+/**
+ * return true if the assistant has an error message to display for the current step.
+ * @return {boolean}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.hasError = function( ) { ; }
+
+/**
+ * set the error message for the currrent step.
+ * @param {string} html error message (rich text) to display on the page to the user
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.setError = function( html ) { ; }
+
+/**
+ * mark a step as current. It will be highlighted accordingly when the page is displayed
+ * @param {nlobjAssistantStep} step assistant step object representing the current step that the user is on.
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.setCurrentStep = function( step ) { ; }
+
+/**
+ * add a step to the assistant.
+ * @param {string} name the name of the step
+ * @param {string} label label used for this step
+ * @return {nlobjAssistantStep}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.addStep = function( name, label ) { ; }
+
+/**
+ * add a field to this page and return it.
+ * @param {string} name field name
+ * @param {string} type field type
+ * @param {string} [label] field label
+ * @param {string, int} [source] script ID or internal ID for source list (select and multiselects only) -or- radio value for radio fields
+ * @param {string} [group] group name that this field will live on. If empty then the field is added to the main section of the page
+ * @return {nlobjField}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.addField = function( name,type,label,source, group ) { ; }
+
+/**
+ * add a sublist to this page and return it. For now only sublists of type inlineeditor are supported
+ * @param {string} name sublist name
+ * @param {string} type sublist type (inlineeditor only for now)
+ * @param {string} label sublist label
+ * @return {nlobjSubList}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.addSubList = function( name,type,label ) { ; }
+
+/**
+ * add a field group to the page.
+ * @param {string} name field group name
+ * @param {string} label field group label
+ * @return {nlobjFieldGroup}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.addFieldGroup = function( name, label ) { ; }
+
+/**
+ * return an assistant step on this page.
+ * @param {string} name step name
+ * @return {nlobjAssistantStep}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getStep = function( name ) { ; }
+
+/**
+ * return a field on this page.
+ * @param {string} name field name
+ * @return {nlobjField}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getField = function( name ) { ; }
+
+/**
+ * return a sublist on this page.
+ * @param {string} name sublist name
+ * @return {nlobjSubList}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getSubList = function( name ) { ; }
+
+/**
+ * return a field group on this page.
+ * @param {string} name field group name
+ * @return {nlobjFieldGroup}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getFieldGroup = function( name ) { ; }
+
+/**
+ * return an array of all the assistant steps for this assistant.
+ * @return {nlobjAssistantStep[]}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getAllSteps = function( ) { ; }
+
+/**
+ * return an array of the names of all fields on this page.
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getAllFields = function( ) { ; }
+
+/**
+ *  return an array of the names of all sublists on this page .
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getAllSubLists = function( ) { ; }
+
+/**
+ * return an array of the names of all field groups on this page.
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getAllFieldGroups = function( ) { ; }
+
+/**
+ * return the last submitted action by the user: next|back|cancel|finish|jump
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getLastAction = function() { ; }
+
+/**
+ * return step from which the last submitted action came from
+ * @return {nlobjAssistantStep}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getLastStep = function() { ; }
+
+/**
+ * return the next logical step corresponding to the user's last submitted action. You should only call this after
+ * you have successfully captured all the information from the last step and are ready to move on to the next step. You
+ * would use the return value to set the current step prior to continuing.
+ *
+ * @return {nlobjAssistantStep}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getNextStep = function() { ; }
+
+/**
+ * return current step set via nlobjAssistant.setCurrentStep(step)
+ * @return {nlobjAssistantStep}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getCurrentStep = function() { ; }
+
+/**
+ * return the total number of steps in the assistant
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.getStepCount = function() { ; }
+
+/**
+ * redirect the user following a user submit operation. Use this to automatically redirect the user to the next logical step.
+ * @param {nlobjResponse} response the response object used to communicate back to the user's client
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjAssistant
+ *
+ * @since 2009.2
+ */
+nlobjAssistant.prototype.sendRedirect = function(response) { ; }
+
+/**
+ * Return a new instance of nlobjField used for scriptable form/sublist field.
+ * This object is READ-ONLY except for scripted fields created via the UI Object API using Suitelets or beforeLoad user events
+ *
+ * @classDescription Core descriptor for fields used to define records and also used to build pages and portlets.
+ * @return {nlobjField}
+ * @constructor
+ */
+function nlobjField( ) { ; }
+
+/**
+ *  return field name.
+ *  @return {string}
+ *
+ * @method
+ * @memberOf nlobjField
+ *
+ * @since 2009.2
+ */
+nlobjField.prototype.getName = function( ) { ; }
+
+/**
+ * return field label.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjField
+ *
+ * @since 2009.2
+ */
+nlobjField.prototype.getLabel = function( ) { ; }
+
+/**
+ * return field type.
+ *  @return {string}
+ *
+ * @method
+ * @memberOf nlobjField
+ *
+ * @since 2009.2
+ */
+nlobjField.prototype.getType = function( ) { ; }
+
+/**
+ * return true if field is hidden.
+ * @return {boolean}
+ *
+ * @method
+ * @memberOf nlobjField
+ *
+ * @since 2009.2
+ */
+nlobjField.prototype.isHidden = function( ) { ; }
+
+/**
+ * return true if field is mandatory.
+ * @return {boolean}
+ *
+ * @method
+ * @memberOf nlobjField
+ *
+ * @since 2009.2
+ */
+nlobjField.prototype.isMandatory = function( ) { ; }
+
+/**
+ * return true if field is disabled.
+ * @return {boolean}
+ *
+ * @method
+ * @memberOf nlobjField
+ *
+ * @since 2009.2
+ */
+nlobjField.prototype.isDisabled = function( ) { ; }
+
+/**
+ * set the label for this field.
+ * This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {string} label
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjField.prototype.setLabel = function( label ) { ; }
+
+/**
+ * set the alias used to set the value for this field. Defaults to field name.
+ * This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {string} alias column used to populate the field (mostly relevant when populating sublist fields)
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjField.prototype.setAlias = function( alias ) { ; }
+
+/**
+ * set the default value for this field.
+ * This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {string} value
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjField.prototype.setDefaultValue = function( value ) { ; }
+
+/**
+ * Disable field via field metadata.
+ * This method is only supported on scripted fields via the UI Object API
+ * @param {boolean} disabled if true then field should be disabled.
+ * @return {nlobjField}
+ *
+ * @method
+ * @memberOf nlobjField
+ *
+ * @since 2009.2
+ */
+nlobjField.prototype.setDisabled = function( disabled ) { ; }
+
+/**
+ * make this field mandatory.
+ * This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {boolean} mandatory if true then field becomes mandatory
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjField.prototype.setMandatory = function( mandatory ) { ; }
+
+/**
+ * set the maxlength for this field (only valid for certain field types).
+ *  This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {int} maxlength maximum length for this field
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjField.prototype.setMaxLength = function( maxlength ) { ; }
+
+/**
+ * set the display type for this field.
+ * This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {string} type display type: inline|normal|hidden|disabled|readonly|entry
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjField.prototype.setDisplayType = function( type ) { ; }
+
+/**
+ * set the break type (startcol|startrow|none) for this field. startrow is only used for fields with a layout type of outside
+ * This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {string} breaktype break type used to add a break in flow layout for this field: startcol|startrow|none
+ * @return {nlobjField}
+ *
+ * @method
+ * @memberOf nlobjField
+ *
+ * @since 2009.2
+ */
+nlobjField.prototype.setBreakType = function( breaktype ) { ; }
+
+
+/**
+ * set the layout type and optionally the break type.
+ * This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {string} type layout type: outside|startrow|midrow|endrow|normal
+ * @param {string} [breaktype] break type: startcol|startrow|none
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjField.prototype.setLayoutType = function( type, breaktype ) { ; }
+
+/**
+ * set the text that gets displayed in lieu of the field value for URL fields.
+ *
+ * @param {string} text user-friendly display value in lieu of URL
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjField.prototype.setLinkText = function( text ) { ; }
+
+/**
+ * set the width and height for this field.
+ * This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {int} width
+ * @param {int} height
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjField.prototype.setDisplaySize = function( width, height ) { ; }
+
+/**
+ * set the amount of emppty vertical space (rows) between this field and the previous field.
+ * This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {int} padding # of empty rows to display above field
+ * @return {nlobjField}
+ *
+ * @since 2008.2
+ */
+nlobjField.prototype.setPadding = function( padding ) { ; }
+
+/**
+ * set help text for this field. If inline is set on assistant pages, help is displayed inline below field
+ * This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {string} help	field level help content (rich text) for field
+ * @param {string} [inline] if true then in addition to the popup field help, the help will also be displayed inline below field (supported on assistant pages only)
+ * @return {nlobjField}
+ *
+ * @method
+ * @memberOf nlobjField
+ *
+ * @since 2009.2
+ */
+nlobjField.prototype.setHelpText = function( help, inline ) { ; }
+
+/**
+ * add a select option to this field (valid for select/multiselect fields).
+ * This method is only supported on scripted fields via the UI Object API
+ *
+ * @param {string} value internal ID for this select option
+ * @param {string} text display value for this select option
+ * @param {boolean} [selected] if true then this select option will be selected by default
+ * @since 2008.2
+ */
+nlobjField.prototype.addSelectOption = function( value, text, selected ) { ; }
+
+/**
+ * Return a new instance of nlobjSubList used for scriptable sublist (sublist).
+ * This object is READ-ONLY except for instances created via the UI Object API using Suitelets or beforeLoad user events.
+ *
+ * @classDescription high level container for defining sublist (many to one) relationships on a record or multi-line data entry UIs on pages.
+ * @return {nlobjSubList}
+ * @constructor
+ */
+function nlobjSubList( ) { ; }
+
+/**
+ * set the label for this sublist.
+ * This method is only supported on sublists via the UI Object API
+ *
+ * @param {string} label
+ * @since 2008.2
+ */
+nlobjSubList.prototype.setLabel = function( label ) { ; }
+
+/**
+ * set helper text for this sublist.
+ * This method is only supported on sublists via the UI Object API
+ *
+ * @param {string} help
+ * @since 2008.2
+ */
+nlobjSubList.prototype.setHelpText = function( help ) { ; }
+
+/**
+ * set the displaytype for this sublist: hidden|normal.
+ * This method is only supported on scripted or staticlist sublists via the UI Object API
+ *
+ * @param {string} type
+ * @since 2008.2
+ */
+nlobjSubList.prototype.setDisplayType = function( type ) { ; }
+
+/**
+ * set the value of a cell in this sublist.
+ *
+ * @param {string} 	field sublist field name
+ * @param {int} 	line  line number (1-based)
+ * @param {string} 	value sublist value
+ *
+ * @method
+ * @memberOf nlobjSubList
+ *
+ * @since 2008.2
+ */
+nlobjSubList.prototype.setLineItemValue = function( field, line, value ) { ; }
+
+/**
+ * set the value of a matrix cell in this sublist.
+ * @param {string} 	field	matrix field name
+ * @param {int} 	line 	line number (1-based)
+ * @param {int} 	column  matrix column index (1-based)
+ * @param {string} 	value   matrix field value
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjSubList
+ *
+ * @since 2009.2
+ */
+nlobjSubList.prototype.setLineItemMatrixValue = function( field, line, column, value ) { ; }
+
+/**
+ * set values for multiple lines (Array of nlobjSearchResults or name-value pair Arrays) in this sublist.
+ * Note that this method is only supported on scripted sublists via the UI Object API
+ *
+ * @param {string[][], nlobjSearchResult[]} values
+ * @since 2008.2
+ */
+nlobjSubList.prototype.setLineItemValues = function( values ) { ; }
+
+/**
+ * Return the number of lines in a sublist.
+ *
+ * @param {string} group sublist name
+ *
+ * @method
+ * @memberOf nlobjSubList
+ * @since 2010.1
+ */
+nlobjSubList.prototype.getLineItemCount = function( group ) { ; }
+
+/**
+ * add a field (column) to this sublist.
+ *
+ * @param {string} name field name
+ * @param {string} type field type
+ * @param {string} label field label
+ * @param {string, int} [source] script ID or internal ID for source list used for this select field
+ * @return {nlobjField}
+ *
+ * @method
+ * @memberOf nlobjSubList
+ *
+ * @since 2008.2
+ */
+nlobjSubList.prototype.addField = function( name,type,label,source ) { ; }
+
+/**
+ * designate a field on sublist that must be unique across all lines (only supported on sublists of type inlineeditor, editor).
+ * @param {string} fldnam the name of a field on this sublist whose value must be unique across all lines
+ * @return {nlobjField}
+ *
+ * @method
+ * @memberOf nlobjSubList
+ *
+ * @since 2009.2
+ */
+nlobjSubList.prototype.setUniqueField = function( fldnam ) { ; }
+
+/**
+ * add a button to this sublist.
+ *
+ * @param {string} name button name
+ * @param {string} label button label
+ * @param {string} script button script (function name)
+ * @return {nlobjButton}
+ *
+ * @method
+ * @memberOf nlobjSubList
+ *
+ * @since 2008.2
+ */
+nlobjSubList.prototype.addButton = function( name, label, script ) { ; }
+
+/**
+ * add "Refresh" button to sublists of type "staticlist" to support manual refreshing of the sublist (without entire page reloads) if it's contents are very volatile
+ * @return {nlobjButton}
+ *
+ * @method
+ * @memberOf nlobjSubList
+ *
+ * @since 2009.2
+ */
+nlobjSubList.prototype.addRefreshButton = function( ) { ; }
+
+/**
+ * add "Mark All" and "Unmark All" buttons to this sublist of type "list".
+ *
+ * @method
+ * @memberOf nlobjSubList
+ *
+ * @since 2008.2
+ */
+nlobjSubList.prototype.addMarkAllButtons = function( ) { ; }
+
+/**
+ * Return a new instance of nlobjColumn used for scriptable list column.
+ *
+ * @classDescription Class definition for columns used on lists and list portlets.
+ * @return {nlobjColumn}
+ * @constructor
+ */
+function nlobjColumn( ) { ; }
+
+/**
+ * set the header name for this column.
+ *
+ * @param {string} label the label for this column
+ *
+ * @method
+ * @memberOf nlobjColumn
+ *
+ * @since 2008.2
+ */
+nlobjColumn.prototype.setLabel = function( label ) { ; }
+
+/**
+ * set the base URL (optionally defined per row) for this column.
+ *
+ * @param {string} value the base URL or a column in the datasource that returns the base URL for each row
+ * @param {boolean} perRow if true then the 1st arg is expected to be a column in the datasource
+ *
+ * @method
+ * @memberOf nlobjColumn
+ *
+ * @since 2008.2
+ */
+nlobjColumn.prototype.setURL = function( value, perRow ) { ; }
+
+/**
+ * add a URL parameter (optionally defined per row) to this column's URL.
+ *
+ * @param {string} param the name of a parameter to add to URL
+ * @param {string} value the value of the parameter to add to URL -or- a column in the datasource that returns the parameter value for each row
+ * @param {boolean} [perRow] if true then the 2nd arg is expected to be a column in the datasource
+ *
+ * @method
+ * @memberOf nlobjColumn
+ *
+ * @since 2008.2
+ */
+nlobjColumn.prototype.addParamToURL = function( param, value, perRow ) { ; }
+
+/**
+ * Return a new instance of nlobjTab used for scriptable tab or subtab.
+ *
+ * @classDescription high level grouping for fields on a data entry form (nlobjForm).
+ * @return {nlobjTab}
+ * @constructor
+ */
+function nlobjTab( ) { ; }
+
+/**
+ * set the label for this tab or subtab.
+ *
+ * @param {string} label string used as label for this tab or subtab
+ * @return {nlobjTab}
+ *
+ * @since 2008.2
+ */
+nlobjTab.prototype.setLabel = function( label ) { ; }
+
+/**
+ * set helper text for this tab or subtab.
+ *
+ * @param {string} help inline help text used for this tab or subtab
+ * @return {nlobjTab}
+ *
+ * @since 2008.2
+ */
+nlobjTab.prototype.setHelpText = function( help ) { ; }
+
+/**
+ * Return a new instance of nlobjAssistantStep.
+ *
+ * @classDescription assistant step definition. Used to define individual steps/pages in multi-step workflows.
+ * @return {nlobjAssistantStep}
+ * @constructor
+ *
+ * @since 2009.2
+ */
+function nlobjAssistantStep( ) { ; }
+
+/**
+ * set the label for this assistant step.
+ * @param {string} label display label used for this assistant step
+ * @return {void}
+ *
+ * @method
+ * @memberOf nlobjAssistantStep
+ *
+ * @since 2009.2
+ */
+nlobjAssistantStep.prototype.setLabel = function( label ) { ; }
+
+/**
+ * set helper text for this assistant step.
+ * @param {string} help inline help text to display on assistant page for this step
+ * @return {nlobjAssistantStep}
+ *
+ * @method
+ * @memberOf nlobjAssistantStep
+ *
+ * @since 2009.2
+ */
+nlobjAssistantStep.prototype.setHelpText = function( help ) { ; }
+
+/**
+ * return the index of this step in the assistant page (1-based)
+ * @return  {int} the index of this step in the assistant (1-based) based on the order in which the steps were added.
+ *
+ * @method
+ * @memberOf nlobjAssistantStep
+ *
+ * @since 2009.2
+ */
+nlobjAssistantStep.prototype.getStepNumber = function( ) { ; }
+
+/**
+ * return the value of a field entered by the user during this step.
+ * @param {string} name field name
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjAssistantStep
+ *
+ * @since 2009.2
+ */
+nlobjAssistantStep.prototype.getFieldValue = function( name ) { ; }
+
+/**
+ * return the selected values of a multi-select field as an Array entered by the user during this step.
+ * @param {string} name multi-select field name
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjAssistantStep
+ *
+ * @since 2009.2
+ */
+nlobjAssistantStep.prototype.getFieldValues = function( name ) { ; }
+
+/**
+ * return the number of lines previously entered by the user in this step (or -1 if the sublist does not exist).
+ * @param {string} group sublist name
+ * @return {int}
+ *
+ * @method
+ * @memberOf nlobjAssistantStep
+ *
+ * @since 2009.2
+ */
+nlobjAssistantStep.prototype.getLineItemCount = function( group ) { ; }
+
+/**
+ * return the value of a sublist field entered by the user during this step.
+ * @param {string} 	group sublist name
+ * @param {string} 	name sublist field name
+ * @param {int} 	line sublist (1-based)
+ * @return  {string}
+ *
+ * @method
+ * @memberOf nlobjAssistantStep
+ *
+ * @since 2009.2
+ */
+nlobjAssistantStep.prototype.getLineItemValue = function(group, name, line) { ; }
+
+/**
+ * return an array of the names of all fields entered by the user during this step.
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjAssistantStep
+ *
+ * @since 2009.2
+ */
+nlobjAssistantStep.prototype.getAllFields = function( ) { ; }
+
+/**
+ * return an array of the names of all sublists entered by the user during this step.
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjAssistantStep
+ *
+ * @since 2009.2
+ */
+nlobjAssistantStep.prototype.getAllLineItems = function( ) { ; }
+
+/**
+ * return an array of the names of all sublist fields entered by the user during this step
+ * @param {string} group sublist name
+ * @return {string[]}
+ *
+ * @method
+ * @memberOf nlobjAssistantStep
+ *
+ * @since 2009.2
+ */
+nlobjAssistantStep.prototype.getAllLineItemFields = function( group ) { ; }
+
+/**
+ * Return a new instance of nlobjFieldGroup (currently only supported on nlobjAssistant pages)
+ *
+ * @classDescription object used for grouping fields on pages (currently only supported on assistant pages).
+ * @return {nlobjFieldGroup}
+ * @constructor
+ *
+ * @since 2009.2
+ */
+function nlobjFieldGroup( ) { ; }
+
+/**
+ * set the label for this field group.
+ * @param {string} label display label for field group
+ * @return {nlobjFieldGroup}
+ *
+ * @method
+ * @memberOf nlobjFieldGroup
+ *
+ * @since 2009.2
+ */
+nlobjFieldGroup.prototype.setLabel = function( label ) { ; }
+
+/**
+ * set collapsibility property for this field group.
+ *
+ * @param {boolean} collapsible if true then this field group is collapsible
+ * @param {boolean} [defaultcollapsed] if true and the field group is collapsible, collapse this field group by default
+ * @return {nlobjFieldGroup}
+ *
+ * @method
+ * @memberOf nlobjFieldGroup
+ *
+ * @since 2009.2
+ */
+nlobjFieldGroup.prototype.setCollapsible = function( collapsible, defaultcollapsed ) { ; }
+
+/**
+ * set singleColumn property for this field group.
+ *
+ * @param {boolean} singleColumn if true then this field group is displayed in single column
+ * @return {nlobjFieldGroup}
+ *
+ * @method
+ * @memberOf nlobjFieldGroup
+ *
+ * @since 2011.1
+ */
+nlobjFieldGroup.prototype.setSingleColumn = function( singleColumn ) { ; }
+
+/**
+ * set showBorder property for this field group.
+ *
+ * @param {boolean} showBorder if true then this field group shows border including label of group
+ * @return {nlobjFieldGroup}
+ *
+ * @method
+ * @memberOf nlobjFieldGroup
+ *
+ * @since 2011.1
+ */
+nlobjFieldGroup.prototype.setShowBorder = function( showBorder ) { ; }
+
+/**
+ * Return a new instance of nlobjButton.
+ *
+ * @classDescription buttons used for triggering custom behaviors on pages.
+ * @return {nlobjButton}
+ * @constructor
+ *
+ * @since 2009.2
+ */
+function nlobjButton( ) { ; }
+
+/**
+ * set the label for this button.
+ * @param {string} label display label for button
+ * @return {nlobjButton}
+ *
+ * @method
+ * @memberOf nlobjButton
+ *
+ * @since 2008.2
+ */
+nlobjButton.prototype.setLabel = function( label ) { ; }
+
+/**
+ * disable or enable button.
+ * @param {boolean} disabled if true then this button should be disabled on the page
+ * @return {nlobjButton}
+ *
+ * @method
+ * @memberOf nlobjButton
+ *
+ * @since 2008.2
+ */
+nlobjButton.prototype.setDisabled = function( disabled ) { ; }
+
+/**
+ * Return a new instance of nlobjSelectOption.
+ *
+ * @classDescription select|radio option used for building select fields via the UI Object API and for describing select|radio fields.
+ * @return {nlobjSelectOption}
+ * @constructor
+ *
+ * @since 2009.2
+ */
+function nlobjSelectOption( ) { ; }
+
+/**
+ * return internal ID for select option
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSelectOption
+ *
+ * @since 2009.2
+ */
+nlobjSelectOption.prototype.getId = function( ) { ; }
+
+/**
+ * return display value for select option.
+ * @return {string}
+ *
+ * @method
+ * @memberOf nlobjSelectOption
+ *
+ * @since 2009.2
+ */
+nlobjSelectOption.prototype.getText = function( ) { ; }
+
+
+
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjAssistant.html b/doc/netsuite/nlobjAssistant.html new file mode 100644 index 0000000..2b41519 --- /dev/null +++ b/doc/netsuite/nlobjAssistant.html @@ -0,0 +1,3955 @@ + + + + + JSDoc: Class: nlobjAssistant + + + + + + + + + + +
+ +

Class: nlobjAssistant

+ + + + + +
+ +
+

+ nlobjAssistant +

+ +
+ +
+
+ + + + +
+

new nlobjAssistant() → {nlobjAssistant}

+ + +
+
+ + +
+ Return a new instance of nlobjAssistant. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjAssistant + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

addField(name, type, label, source, group) → {nlobjField}

+ + +
+
+ + +
+ add a field to this page and return it. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
name + + +string + + + + + + + + field name
type + + +string + + + + + + + + field type
label + + +string + + + + + + <optional>
+ + + + 		field label
source + + +string, int + + + + + + <optional>
+ + + + 		script ID or internal ID for source list (select and multiselects only) -or- radio value for radio fields
group + + +string + + + + + + <optional>
+ + + + 		group name that this field will live on. If empty then the field is added to the main section of the page
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

addFieldGroup(name, label) → {nlobjFieldGroup}

+ + +
+
+ + +
+ add a field group to the page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field group name
label + + +string + + + + field group label
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFieldGroup + + +
+
+ + + + +
+ + + +
+

addStep(name, label) → {nlobjAssistantStep}

+ + +
+
+ + +
+ add a step to the assistant. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + the name of the step
label + + +string + + + + label used for this step
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjAssistantStep + + +
+
+ + + + +
+ + + +
+

addSubList(name, type, label) → {nlobjSubList}

+ + +
+
+ + +
+ add a sublist to this page and return it. For now only sublists of type inlineeditor are supported +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + sublist name
type + + +string + + + + sublist type (inlineeditor only for now)
label + + +string + + + + sublist label
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSubList + + +
+
+ + + + +
+ + + +
+

getAllFieldGroups() → {string[]}

+ + +
+
+ + +
+ return an array of the names of all field groups on this page. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getAllFields() → {string[]}

+ + +
+
+ + +
+ return an array of the names of all fields on this page. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getAllSteps() → {nlobjAssistantStep[]}

+ + +
+
+ + +
+ return an array of all the assistant steps for this assistant. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjAssistantStep[] + + +
+
+ + + + +
+ + + +
+

getAllSubLists() → {string[]}

+ + +
+
+ + +
+ return an array of the names of all sublists on this page . +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getCurrentStep() → {nlobjAssistantStep}

+ + +
+
+ + +
+ return current step set via nlobjAssistant.setCurrentStep(step) +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjAssistantStep + + +
+
+ + + + +
+ + + +
+

getField(name) → {nlobjField}

+ + +
+
+ + +
+ return a field on this page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

getFieldGroup(name) → {nlobjFieldGroup}

+ + +
+
+ + +
+ return a field group on this page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field group name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFieldGroup + + +
+
+ + + + +
+ + + +
+

getLastAction() → {string}

+ + +
+
+ + +
+ return the last submitted action by the user: next|back|cancel|finish|jump +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getLastStep() → {nlobjAssistantStep}

+ + +
+
+ + +
+ return step from which the last submitted action came from +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjAssistantStep + + +
+
+ + + + +
+ + + +
+

getNextStep() → {nlobjAssistantStep}

+ + +
+
+ + +
+ return the next logical step corresponding to the user's last submitted action. You should only call this after +you have successfully captured all the information from the last step and are ready to move on to the next step. You +would use the return value to set the current step prior to continuing. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjAssistantStep + + +
+
+ + + + +
+ + + +
+

getStep(name) → {nlobjAssistantStep}

+ + +
+
+ + +
+ return an assistant step on this page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + step name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjAssistantStep + + +
+
+ + + + +
+ + + +
+

getStepCount() → {int}

+ + +
+
+ + +
+ return the total number of steps in the assistant +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getSubList(name) → {nlobjSubList}

+ + +
+
+ + +
+ return a sublist on this page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSubList + + +
+
+ + + + +
+ + + +
+

hasError() → {boolean}

+ + +
+
+ + +
+ return true if the assistant has an error message to display for the current step. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ + + +
+

isFinished() → {boolean}

+ + +
+
+ + +
+ return true if all the steps have been completed. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ + + +
+

sendRedirect(response) → {void}

+ + +
+
+ + +
+ redirect the user following a user submit operation. Use this to automatically redirect the user to the next logical step. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
response + + +nlobjResponse + + + + the response object used to communicate back to the user's client
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setCurrentStep(step) → {void}

+ + +
+
+ + +
+ mark a step as current. It will be highlighted accordingly when the page is displayed +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
step + + +nlobjAssistantStep + + + + assistant step object representing the current step that the user is on.
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setError(html) → {void}

+ + +
+
+ + +
+ set the error message for the currrent step. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
html + + +string + + + + error message (rich text) to display on the page to the user
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setFieldValues(values) → {void}

+ + +
+
+ + +
+ set the values for all the fields on this page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
values + + +Object + + + + Object of field name/value pairs used to set all fields on page
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setFinished(html) → {void}

+ + +
+
+ + +
+ mark assistant page as completed and optionally set the rich text to display on completed page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
html + + +string + + + + completion message (rich text) to display on the "Finish" page
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setNumbered(numbered) → {void}

+ + +
+
+ + +
+ if numbered, step numbers are displayed next to the step's label in the navigation area +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
numbered + + +boolean + + + + If true (default assistant behavior) step numbers will be displayed next to the step label
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setOrdered(ordered) → {void}

+ + +
+
+ + +
+ if ordered, steps are show on left and must be completed sequentially, otherwise steps are shown on top and can be done in any order +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
ordered + + +boolean + + + + If true (default assistant behavior) then a navigation order thru the steps/pages will be imposed on the user. Otherwise the user + will be allowed to navigate across steps/pages in any order they choose.
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setScript(script) → {void}

+ + +
+
+ + +
+ set the script ID for Client Script used for this form. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
script + + +string, int + + + + script ID or internal ID for global client script used to enable Client SuiteScript on page
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setShortcut(show) → {void}

+ + +
+
+ + +
+ show/hide shortcut link. Always hidden on external pages +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
show + + +boolean + + + + enable/disable "Add To Shortcut" link on this page
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setSplash(title, text1, text2) → {void}

+ + +
+
+ + +
+ set the splash screen used for this page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
title + + +string + + + + + + + + splash portlet title
text1 + + +string + + + + + + + + splash portlet content (left side)
text2 + + +string + + + + + + <optional>
+ + + + 		splash portlet content (right side)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setTitle(title) → {void}

+ + +
+
+ + +
+ set the page title. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
title + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjAssistantStep.html b/doc/netsuite/nlobjAssistantStep.html new file mode 100644 index 0000000..9a86580 --- /dev/null +++ b/doc/netsuite/nlobjAssistantStep.html @@ -0,0 +1,1416 @@ + + + + + JSDoc: Class: nlobjAssistantStep + + + + + + + + + + +
+ +

Class: nlobjAssistantStep

+ + + + + +
+ +
+

+ nlobjAssistantStep +

+ +
+ +
+
+ + + + +
+

new nlobjAssistantStep() → {nlobjAssistantStep}

+ + +
+
+ + +
+ Return a new instance of nlobjAssistantStep. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjAssistantStep + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

getAllFields() → {string[]}

+ + +
+
+ + +
+ return an array of the names of all fields entered by the user during this step. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getAllLineItemFields(group) → {string[]}

+ + +
+
+ + +
+ return an array of the names of all sublist fields entered by the user during this step +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getAllLineItems() → {string[]}

+ + +
+
+ + +
+ return an array of the names of all sublists entered by the user during this step. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getFieldValue(name) → {string}

+ + +
+
+ + +
+ return the value of a field entered by the user during this step. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getFieldValues(name) → {string[]}

+ + +
+
+ + +
+ return the selected values of a multi-select field as an Array entered by the user during this step. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + multi-select field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getLineItemCount(group) → {int}

+ + +
+
+ + +
+ return the number of lines previously entered by the user in this step (or -1 if the sublist does not exist). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getLineItemValue(group, name, line) → {string}

+ + +
+
+ + +
+ return the value of a sublist field entered by the user during this step. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
name + + +string + + + + sublist field name
line + + +int + + + + sublist (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getStepNumber() → {int}

+ + +
+
+ + +
+ return the index of this step in the assistant page (1-based) +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ the index of this step in the assistant (1-based) based on the order in which the steps were added. +
+ + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

setHelpText(help) → {nlobjAssistantStep}

+ + +
+
+ + +
+ set helper text for this assistant step. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
help + + +string + + + + inline help text to display on assistant page for this step
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjAssistantStep + + +
+
+ + + + +
+ + + +
+

setLabel(label) → {void}

+ + +
+
+ + +
+ set the label for this assistant step. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
label + + +string + + + + display label used for this assistant step
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjButton.html b/doc/netsuite/nlobjButton.html new file mode 100644 index 0000000..d669d2c --- /dev/null +++ b/doc/netsuite/nlobjButton.html @@ -0,0 +1,438 @@ + + + + + JSDoc: Class: nlobjButton + + + + + + + + + + +
+ +

Class: nlobjButton

+ + + + + +
+ +
+

+ nlobjButton +

+ +
+ +
+
+ + + + +
+

new nlobjButton() → {nlobjButton}

+ + +
+
+ + +
+ Return a new instance of nlobjButton. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjButton + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

setDisabled(disabled) → {nlobjButton}

+ + +
+
+ + +
+ disable or enable button. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
disabled + + +boolean + + + + if true then this button should be disabled on the page
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjButton + + +
+
+ + + + +
+ + + +
+

setLabel(label) → {nlobjButton}

+ + +
+
+ + +
+ set the label for this button. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
label + + +string + + + + display label for button
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjButton + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjColumn.html b/doc/netsuite/nlobjColumn.html new file mode 100644 index 0000000..9cdbc17 --- /dev/null +++ b/doc/netsuite/nlobjColumn.html @@ -0,0 +1,606 @@ + + + + + JSDoc: Class: nlobjColumn + + + + + + + + + + +
+ +

Class: nlobjColumn

+ + + + + +
+ +
+

+ nlobjColumn +

+ +
+ +
+
+ + + + +
+

new nlobjColumn() → {nlobjColumn}

+ + +
+
+ + +
+ Return a new instance of nlobjColumn used for scriptable list column. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjColumn + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

addParamToURL(param, value, perRow)

+ + +
+
+ + +
+ add a URL parameter (optionally defined per row) to this column's URL. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
param + + +string + + + + + + + + the name of a parameter to add to URL
value + + +string + + + + + + + + the value of the parameter to add to URL -or- a column in the datasource that returns the parameter value for each row
perRow + + +boolean + + + + + + <optional>
+ + + + 		if true then the 2nd arg is expected to be a column in the datasource
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setLabel(label)

+ + +
+
+ + +
+ set the header name for this column. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
label + + +string + + + + the label for this column
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setURL(value, perRow)

+ + +
+
+ + +
+ set the base URL (optionally defined per row) for this column. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
value + + +string + + + + the base URL or a column in the datasource that returns the base URL for each row
perRow + + +boolean + + + + if true then the 1st arg is expected to be a column in the datasource
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjConfiguration.html b/doc/netsuite/nlobjConfiguration.html new file mode 100644 index 0000000..495e91f --- /dev/null +++ b/doc/netsuite/nlobjConfiguration.html @@ -0,0 +1,1640 @@ + + + + + JSDoc: Class: nlobjConfiguration + + + + + + + + + + +
+ +

Class: nlobjConfiguration

+ + + + + +
+ +
+

+ nlobjConfiguration +

+ +
+ +
+
+ + + + +
+

new nlobjConfiguration() → {nlobjConfiguration}

+ + +
+
+ + +
+ Return a new instance of nlobjConfiguration.. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjConfiguration + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

getAllFields() → {string[]}

+ + +
+
+ + +
+ return an Array of all field names on the record. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getField(fldnam) → {nlobjField}

+ + +
+
+ + +
+ return field metadata for field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

getFieldText(name) → {string}

+ + +
+
+ + +
+ return the text value of a field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getFieldTexts(name) → {string[]}

+ + +
+
+ + +
+ return the selected text values of a multi-select field as an Array. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getFieldValue(name) → {string}

+ + +
+
+ + +
+ return the value of a field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getFieldValues(name) → {string[]}

+ + +
+
+ + +
+ return the selected values of a multi-select field as an Array. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getType() → {string}

+ + +
+
+ + +
+ return the type corresponding to this setup record. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

setFieldText(name, text) → {void}

+ + +
+
+ + +
+ set the value (via display value) of a field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
text + + +string + + + + field display text
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setFieldTexts(name, texts) → {void}

+ + +
+
+ + +
+ set the values (via display values) of a multi-select field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
texts + + +string[] + + + + array of field display text values
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setFieldValue(name, value) → {void}

+ + +
+
+ + +
+ set the value of a field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
value + + +string + + + + field value
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setFieldValues(name, value) → {void}

+ + +
+
+ + +
+ Set the values of a multi-select field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
value + + +string[] + + + + field values
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjContext.html b/doc/netsuite/nlobjContext.html new file mode 100644 index 0000000..f1e43ec --- /dev/null +++ b/doc/netsuite/nlobjContext.html @@ -0,0 +1,3069 @@ + + + + + JSDoc: Class: nlobjContext + + + + + + + + + + +
+ +

Class: nlobjContext

+ + + + + +
+ +
+

+ nlobjContext +

+ +
+ +
+
+ + + + +
+

new nlobjContext() → {nlobjContext}

+ + +
+
+ + +
+ Return a new instance of nlobjContext used for user and script context information. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjContext + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

getAllSessionObjects() → {string[]}

+ + +
+
+ + +
+ return an array containing the names of all keys used to set session objects +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getColorPreferences() → {Object}

+ + +
+
+ + +
+ return an Object containing name/value pairs of color groups to their corresponding RGB hex color based on the currenly logged in user's color them preferences. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2010.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + +
+ + + +
+

getCompany() → {string}

+ + +
+
+ + +
+ return the account ID of the current user. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getContact() → {int}

+ + +
+
+ + +
+ return the internal ID of the contact logged in on behalf of a customer, vendor, or partner. It returns -1 for non-contact logins +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getDepartment() → {int}

+ + +
+
+ + +
+ return the internalId of the current user's department. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getDeploymentId() → {string}

+ + +
+
+ + +
+ return the deployment ID for the current script +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getEmail() → {string}

+ + +
+
+ + +
+ return the email address of the current user. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getEnvironment()

+ + +
+
+ + +
+ return the environment that the script is executing in: SANDBOX, PRODUCTION, BETA, INTERNAL +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

getExecutionContext() → {string}

+ + +
+
+ + +
+ return the execution context for this script: webServices|csvImport|client|userInterface|scheduledScript|portlet|suitelet|debugger|custommassupdate +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getFeature(name) → {boolean}

+ + +
+
+ + +
+ return true if feature is enabled, false otherwise +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ + + +
+

getLocation() → {int}

+ + +
+
+ + +
+ return the internalId of the current user's location. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getLogLevel()

+ + +
+
+ + +
+ return the logging level for the current script execution. Not supported in CLIENT scripts +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

getName() → {string}

+ + +
+
+ + +
+ return the name of the current user. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getPercentComplete() → {int}

+ + +
+
+ + +
+ return the % complete specified for the current scheduled script execution +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getPermission(name) → {int}

+ + +
+
+ + +
+ return current user's permission level (0-4) for this permission +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getPreference(name) → {string}

+ + +
+
+ + +
+ return system or script preference selection for current user +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getRemainingUsage() → {int}

+ + +
+
+ + +
+ return the amount of usage units remaining for this script. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getRole() → {string}

+ + +
+
+ + +
+ return the internalId of the current user's role. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getRoleCenter() → {string}

+ + +
+
+ + +
+ return the internalId of the current user's center type. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getRoleId() → {string}

+ + +
+
+ + +
+ return the script ID of the current user's role. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getScriptId() → {string}

+ + +
+
+ + +
+ return the script ID for the current script +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getSessionObject(name) → {string}

+ + +
+
+ + +
+ return value of session object set by script +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getSetting(type, name)

+ + +
+
+ + +
+ return a system/script setting. Types are SCRIPT, SESSION, FEATURE, PERMISSION +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + +
name + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + +
Deprecated:
  • Yes
+ + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

getSubsidiary() → {int}

+ + +
+
+ + +
+ return the internalId of the current user's subsidiary. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getUser() → {string}

+ + +
+
+ + +
+ return the internalId of the current user. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getVersion() → {string}

+ + +
+
+ + +
+ return the NetSuite version for the current account +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

setPercentComplete(ct) → {void}

+ + +
+
+ + +
+ set the % complete for the current scheduled script execution +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
ct + + +float + + + + the percentage of records completed
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setSessionObject(name, value) → {void}

+ + +
+
+ + +
+ set the value of a session object using a key. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + +
value + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setSetting(type, name, value)

+ + +
+
+ + +
+ set a system/script setting. Only supported type is SESSION +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + +
name + + +string + + + +
value + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + +
Deprecated:
  • Yes
+ + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjError.html b/doc/netsuite/nlobjError.html new file mode 100644 index 0000000..ab354c4 --- /dev/null +++ b/doc/netsuite/nlobjError.html @@ -0,0 +1,683 @@ + + + + + JSDoc: Class: nlobjError + + + + + + + + + + +
+ +

Class: nlobjError

+ + + + + +
+ +
+

+ nlobjError +

+ +
+ +
+
+ + + + +
+

new nlobjError() → {nlobjError}

+ + +
+
+ + +
+ Return a new instance of nlobjError used system or user-defined error object. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjError + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

getCode() → {string}

+ + +
+
+ + +
+ return the error code for this system or user-defined error. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getDetails() → {string}

+ + +
+
+ + +
+ return the error description for this error. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getId() → {string}

+ + +
+
+ + +
+ return the error db ID for this error (if it was an unhandled unexpected error). +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getInternalId() → {int}

+ + +
+
+ + +
+ return the internalid of the record if this error was thrown in an aftersubmit script. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getStackTrace() → {string[]}

+ + +
+
+ + +
+ return a stacktrace containing the location of the error. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getUserEvent() → {string}

+ + +
+
+ + +
+ return the userevent script name where this error was thrown. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjField.html b/doc/netsuite/nlobjField.html new file mode 100644 index 0000000..9eaa2a5 --- /dev/null +++ b/doc/netsuite/nlobjField.html @@ -0,0 +1,2724 @@ + + + + + JSDoc: Class: nlobjField + + + + + + + + + + +
+ +

Class: nlobjField

+ + + + + +
+ +
+

+ nlobjField +

+ +
+ +
+
+ + + + +
+

new nlobjField() → {nlobjField}

+ + +
+
+ + +
+ Return a new instance of nlobjField used for scriptable form/sublist field. +This object is READ-ONLY except for scripted fields created via the UI Object API using Suitelets or beforeLoad user events +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

addSelectOption(value, text, selected)

+ + +
+
+ + +
+ add a select option to this field (valid for select/multiselect fields). +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
value + + +string + + + + + + + + internal ID for this select option
text + + +string + + + + + + + + display value for this select option
selected + + +boolean + + + + + + <optional>
+ + + + 		if true then this select option will be selected by default
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

getLabel() → {string}

+ + +
+
+ + +
+ return field label. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getName() → {string}

+ + +
+
+ + +
+ return field name. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getType() → {string}

+ + +
+
+ + +
+ return field type. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

isDisabled() → {boolean}

+ + +
+
+ + +
+ return true if field is disabled. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ + + +
+

isHidden() → {boolean}

+ + +
+
+ + +
+ return true if field is hidden. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ + + +
+

isMandatory() → {boolean}

+ + +
+
+ + +
+ return true if field is mandatory. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ + + +
+

setAlias(alias) → {nlobjField}

+ + +
+
+ + +
+ set the alias used to set the value for this field. Defaults to field name. +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
alias + + +string + + + + column used to populate the field (mostly relevant when populating sublist fields)
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setBreakType(breaktype) → {nlobjField}

+ + +
+
+ + +
+ set the break type (startcol|startrow|none) for this field. startrow is only used for fields with a layout type of outside +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
breaktype + + +string + + + + break type used to add a break in flow layout for this field: startcol|startrow|none
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setDefaultValue(value) → {nlobjField}

+ + +
+
+ + +
+ set the default value for this field. +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
value + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setDisabled(disabled) → {nlobjField}

+ + +
+
+ + +
+ Disable field via field metadata. +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
disabled + + +boolean + + + + if true then field should be disabled.
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setDisplaySize(width, height) → {nlobjField}

+ + +
+
+ + +
+ set the width and height for this field. +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
width + + +int + + + +
height + + +int + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setDisplayType(type) → {nlobjField}

+ + +
+
+ + +
+ set the display type for this field. +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + display type: inline|normal|hidden|disabled|readonly|entry
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setHelpText(help, inline) → {nlobjField}

+ + +
+
+ + +
+ set help text for this field. If inline is set on assistant pages, help is displayed inline below field +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
help + + +string + + + + + + + + field level help content (rich text) for field
inline + + +string + + + + + + <optional>
+ + + + 		if true then in addition to the popup field help, the help will also be displayed inline below field (supported on assistant pages only)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setLabel(label) → {nlobjField}

+ + +
+
+ + +
+ set the label for this field. +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
label + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setLayoutType(type, breaktype) → {nlobjField}

+ + +
+
+ + +
+ set the layout type and optionally the break type. +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + layout type: outside|startrow|midrow|endrow|normal
breaktype + + +string + + + + + + <optional>
+ + + + 		break type: startcol|startrow|none
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setLinkText(text) → {nlobjField}

+ + +
+
+ + +
+ set the text that gets displayed in lieu of the field value for URL fields. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
text + + +string + + + + user-friendly display value in lieu of URL
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setMandatory(mandatory) → {nlobjField}

+ + +
+
+ + +
+ make this field mandatory. +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
mandatory + + +boolean + + + + if true then field becomes mandatory
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setMaxLength(maxlength) → {nlobjField}

+ + +
+
+ + +
+ set the maxlength for this field (only valid for certain field types). + This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
maxlength + + +int + + + + maximum length for this field
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

setPadding(padding) → {nlobjField}

+ + +
+
+ + +
+ set the amount of emppty vertical space (rows) between this field and the previous field. +This method is only supported on scripted fields via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
padding + + +int + + + + # of empty rows to display above field
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjFieldGroup.html b/doc/netsuite/nlobjFieldGroup.html new file mode 100644 index 0000000..19a3fa7 --- /dev/null +++ b/doc/netsuite/nlobjFieldGroup.html @@ -0,0 +1,745 @@ + + + + + JSDoc: Class: nlobjFieldGroup + + + + + + + + + + +
+ +

Class: nlobjFieldGroup

+ + + + + +
+ +
+

+ nlobjFieldGroup +

+ +
+ +
+
+ + + + +
+

new nlobjFieldGroup() → {nlobjFieldGroup}

+ + +
+
+ + +
+ Return a new instance of nlobjFieldGroup (currently only supported on nlobjAssistant pages) +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFieldGroup + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

setCollapsible(collapsible, defaultcollapsed) → {nlobjFieldGroup}

+ + +
+
+ + +
+ set collapsibility property for this field group. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
collapsible + + +boolean + + + + + + + + if true then this field group is collapsible
defaultcollapsed + + +boolean + + + + + + <optional>
+ + + + 		if true and the field group is collapsible, collapse this field group by default
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFieldGroup + + +
+
+ + + + +
+ + + +
+

setLabel(label) → {nlobjFieldGroup}

+ + +
+
+ + +
+ set the label for this field group. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
label + + +string + + + + display label for field group
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFieldGroup + + +
+
+ + + + +
+ + + +
+

setShowBorder(showBorder) → {nlobjFieldGroup}

+ + +
+
+ + +
+ set showBorder property for this field group. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
showBorder + + +boolean + + + + if true then this field group shows border including label of group
+ + + +
+ + + + + +
Since:
+
  • 2011.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFieldGroup + + +
+
+ + + + +
+ + + +
+

setSingleColumn(singleColumn) → {nlobjFieldGroup}

+ + +
+
+ + +
+ set singleColumn property for this field group. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
singleColumn + + +boolean + + + + if true then this field group is displayed in single column
+ + + +
+ + + + + +
Since:
+
  • 2011.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFieldGroup + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjFile.html b/doc/netsuite/nlobjFile.html new file mode 100644 index 0000000..cc2776a --- /dev/null +++ b/doc/netsuite/nlobjFile.html @@ -0,0 +1,1834 @@ + + + + + JSDoc: Class: nlobjFile + + + + + + + + + + +
+ +

Class: nlobjFile

+ + + + + +
+ +
+

+ nlobjFile +

+ +
+ +
+
+ + + + +
+

new nlobjFile() → {nlobjFile}

+ + +
+
+ + +
+ Return a new instance of nlobjFile used for accessing and manipulating files in the file cabinet. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFile + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

getDescription() → {string}

+ + +
+
+ + +
+ return the file description. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getFolder() → {int}

+ + +
+
+ + +
+ return the internal ID of the folder that this file is in. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getId() → {int}

+ + +
+
+ + +
+ Return the id of the file (if stored in the FC). +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getName() → {string}

+ + +
+
+ + +
+ Return the name of the file. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getSize() → {int}

+ + +
+
+ + +
+ Return the size of the file in bytes. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getType() → {string}

+ + +
+
+ + +
+ Return the type of the file. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getURL() → {string}

+ + +
+
+ + +
+ Return the URL of the file (if stored in the FC). +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getValue() → {string}

+ + +
+
+ + +
+ Return the value (base64 encoded for binary types) of the file. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

isInactive() → {boolean}

+ + +
+
+ + +
+ return true if the file is inactive. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ + + +
+

isOnline() → {boolean}

+ + +
+
+ + +
+ return true if the file is "Available without Login". +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ + + +
+

setDescription(descr) → {void}

+ + +
+
+ + +
+ sets the file's description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
descr + + +string + + + + the file description
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setEncoding(encoding) → {void}

+ + +
+
+ + +
+ sets the character encoding for the file. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
encoding + + +String + + + +
+ + + +
+ + + + + +
Since:
+
  • 2010.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setFolder(folder) → {void}

+ + +
+
+ + +
+ sets the internal ID of the folder that this file is in. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
folder + + +int + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setIsInactive(inactive) → {void}

+ + +
+
+ + +
+ sets the file's inactive status. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
inactive + + +boolean + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setIsOnline(online) → {void}

+ + +
+
+ + +
+ sets the file's "Available without Login" status. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
online + + +boolean + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setName(name) → {void}

+ + +
+
+ + +
+ Sets the name of a file. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + the name of the file
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjForm.html b/doc/netsuite/nlobjForm.html new file mode 100644 index 0000000..f5337b2 --- /dev/null +++ b/doc/netsuite/nlobjForm.html @@ -0,0 +1,3627 @@ + + + + + JSDoc: Class: nlobjForm + + + + + + + + + + +
+ +

Class: nlobjForm

+ + + + + +
+ +
+

+ nlobjForm +

+ +
+ +
+
+ + + + +
+

new nlobjForm() → {nlobjForm}

+ + +
+
+ + +
+ Return a new instance of nlobjForm used for scriptable form page. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjForm + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

addButton(name, label, script) → {nlobjButton}

+ + +
+
+ + +
+ add a button to this form. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + button name
label + + +string + + + + button label
script + + +string + + + + button script (function name)
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjButton + + +
+
+ + + + +
+ + + +
+

addField(name, type, label, source, tab) → {nlobjField}

+ + +
+
+ + +
+ add a field (nlobjField) to this form and return it. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
name + + +string + + + + + + + + field name
type + + +string + + + + + + + + field type
label + + +string + + + + + + <optional>
+ + + + 		field label
source + + +string, int + + + + + + <optional>
+ + + + 		script ID or internal ID for source list (select and multiselects only) -or- radio value for radio fields
tab + + +string + + + + + + <optional>
+ + + + 		tab name that this field will live on. If empty then the field is added to the main section of the form (immediately below the title bar)
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

addFieldGroup(name, label, tab) → {nlobjFieldGroup}

+ + +
+
+ + +
+ add a field group to the form. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field group name
label + + +string + + + + field group label
tab + +
+ + + +
+ + + + + +
Since:
+
  • 2011.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFieldGroup + + +
+
+ + + + +
+ + + +
+ + + +
+
+ + +
+ add a navigation cross-link to the page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + page link type: crosslink|breadcrumb
title + + +string + + + + page link title
url + + +string + + + + URL for page link
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

addResetButton(label) → {nlobjButton}

+ + +
+
+ + +
+ add a reset button to this form. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
label + + +string + + + + + + <optional>
+ + + + 		label for this button. defaults to "Reset"
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjButton + + +
+
+ + + + +
+ + + +
+

addSubList(name, type, label, tab) → {nlobjSubList}

+ + +
+
+ + +
+ add a sublist (nlobjSubList) to this form and return it. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
name + + +string + + + + + + + + sublist name
type + + +string + + + + + + + + sublist type: inlineeditor|editor|list|staticlist
label + + +string + + + + + + + + sublist label
tab + + +string + + + + + + <optional>
+ + + + 		parent tab that this sublist lives on. If empty, it is added to the main tab
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSubList + + +
+
+ + + + +
+ + + +
+

addSubmitButton(label) → {nlobjButton}

+ + +
+
+ + +
+ add a submit button to this form. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
label + + +string + + + + + + <optional>
+ + + + 		label for this submit button. defaults to "Save"
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjButton + + +
+
+ + + + +
+ + + +
+

addSubTab(name, label, tab) → {nlobjTab}

+ + +
+
+ + +
+ add a subtab (nlobjTab) to this form and return it. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
name + + +string + + + + + + + + subtab name
label + + +string + + + + + + + + subtab label
tab + + +string + + + + + + <optional>
+ + + + 		parent tab that this subtab lives on. If empty, it is added to the main tab.
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjTab + + +
+
+ + + + +
+ + + +
+

addTab(name, label) → {nlobjTab}

+ + +
+
+ + +
+ add a tab (nlobjTab) to this form and return it. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + tab name
label + + +string + + + + tab label
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjTab + + +
+
+ + + + +
+ + + +
+

addTitleHtml(title)

+ + +
+
+ + +
+ set additional title Html. INTERNAL ONLY +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
title + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

getButton(name) → {nlobjButton}

+ + +
+
+ + +
+ get a button from this form by name. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2009.2 add
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjButton + + +
+
+ + + + +
+ + + +
+

getField(name, radio) → {nlobjField}

+ + +
+
+ + +
+ return a field (nlobjField) on this form. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
name + + +string + + + + + + + + field name
radio + + +string + + + + + + <optional>
+ + + + 		if this is a radio field, specify which radio field to return based on radio value
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

getSubList(name) → {nlobjSubList}

+ + +
+
+ + +
+ return a sublist (nlobjSubList) on this form. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSubList + + +
+
+ + + + +
+ + + +
+

getSubTab(name) → {nlobjTab}

+ + +
+
+ + +
+ return a subtab (nlobjTab) on this form. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + subtab name
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjTab + + +
+
+ + + + +
+ + + +
+

getTab(name) → {nlobjTab}

+ + +
+
+ + +
+ return a tab (nlobjTab) on this form. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + tab name
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjTab + + +
+
+ + + + +
+ + + +
+

insertField(field, nextfld) → {nlobjField}

+ + +
+
+ + +
+ insert a field (nlobjField) before another field (name). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
field + + +nlobjField + + + + the field object to insert
nextfld + + +string + + + + the name of the field before which to insert this field
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

insertSubList(sublist, nextsublist) → {nlobjSubList}

+ + +
+
+ + +
+ insert a sublist (nlobjSubList) before another subtab or sublist (name). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
sublist + + +nlobjSubList + + + + the sublist object to insert
nextsublist + + +string + + + + the name of the sublist before which to insert this sublist
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSubList + + +
+
+ + + + +
+ + + +
+

insertSubTab(subtab, nextsubtab) → {nlobjTab}

+ + +
+
+ + +
+ insert a subtab (nlobjTab) before another subtab or sublist (name). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
subtab + + +nlobjTab + + + + the subtab object to insert
nextsubtab + + +string + + + + the name of the subtab before which to insert this subtab
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjTab + + +
+
+ + + + +
+ + + +
+

insertTab(tab, nexttab) → {nlobjTab}

+ + +
+
+ + +
+ insert a tab (nlobjTab) before another tab (name). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
tab + + +nlobjTab + + + + the tab object to insert
nexttab + + +string + + + + the name of the tab before which to insert this tab
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjTab + + +
+
+ + + + +
+ + + +
+

setFieldValues(values)

+ + +
+
+ + +
+ set the values for all the fields on this form. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
values + + +Object + + + + Object containing field name/value pairs
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setScript(script)

+ + +
+
+ + +
+ set the Client Script definition used for this page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
script + + +string, int + + + + script ID or internal ID for global client script used to enable Client SuiteScript on page
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setTitle(title)

+ + +
+
+ + +
+ set the page title. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
title + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjList.html b/doc/netsuite/nlobjList.html new file mode 100644 index 0000000..c7d9f12 --- /dev/null +++ b/doc/netsuite/nlobjList.html @@ -0,0 +1,1504 @@ + + + + + JSDoc: Class: nlobjList + + + + + + + + + + +
+ +

Class: nlobjList

+ + + + + +
+ +
+

+ nlobjList +

+ +
+ +
+
+ + + + +
+

new nlobjList() → {nlobjList}

+ + +
+
+ + +
+ Return a new instance of nlobjList used for scriptable list page. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjList + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

addButton(name, label, script)

+ + +
+
+ + +
+ add a button (nlobjButton) to the footer of this page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + button name
label + + +string + + + + button label
script + + +string + + + + button script (function name)
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

addColumn(name, type, label, align) → {nlobjColumn}

+ + +
+
+ + +
+ add a column (nlobjColumn) to this list and return it. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
name + + +string + + + + + + + + column name
type + + +string + + + + + + + + column type
label + + +string + + + + + + + + column label
align + + +string + + + + + + <optional>
+ + + + 		column alignment
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjColumn + + +
+
+ + + + +
+ + + +
+

addEditColumn(column, showView, showHref) → {nlobjColumn}

+ + +
+
+ + +
+ add an Edit column (nlobjColumn) to the left of the column specified. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
column + + +nlobjColumn + + + + + + + +
showView + + +boolean + + + + + + + + should Edit|View instead of Edit link
showHref + + +string + + + + + + <optional>
+ + + + 		column that evaluates to T or F that determines whether to disable the edit|view link per-row.
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjColumn + + +
+
+ + + + +
+ + + +
+ + + +
+
+ + +
+ add a navigation cross-link to the page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + page link type: crosslink|breadcrumb
title + + +string + + + + page link title
url + + +string + + + + URL for page link
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

addRow(row)

+ + +
+
+ + +
+ add a row (Array of name-value pairs or nlobjSearchResult) to this portlet. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
row + + +string[], nlobjSearchResult + + + + data used to add a single row
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

addRows(rows)

+ + +
+
+ + +
+ add multiple rows (Array of nlobjSearchResults or name-value pair Arrays) to this portlet. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rows + + +string[][], nlobjSearchResult[] + + + + data used to add multiple rows
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setScript(script)

+ + +
+
+ + +
+ set the Client SuiteScript used for this page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
script + + +string, int + + + + script ID or internal ID for global client script used to enable Client SuiteScript on page
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setStyle(style)

+ + +
+
+ + +
+ set the global style for this list: grid|report|plain|normal. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
style + + +string + + + + overall style used to render list
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setTitle(title)

+ + +
+
+ + +
+ set the page title. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
title + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjPortlet.html b/doc/netsuite/nlobjPortlet.html new file mode 100644 index 0000000..4018e3d --- /dev/null +++ b/doc/netsuite/nlobjPortlet.html @@ -0,0 +1,1624 @@ + + + + + JSDoc: Class: nlobjPortlet + + + + + + + + + + +
+ +

Class: nlobjPortlet

+ + + + + +
+ +
+

+ nlobjPortlet +

+ +
+ +
+
+ + + + +
+

new nlobjPortlet() → {nlobjPortlet}

+ + +
+
+ + +
+ Return a new instance of nlobjPortlet used for scriptable dashboard portlet. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjPortlet + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

addColumn(name, type, label, align)

+ + +
+
+ + +
+ add a column (nlobjColumn) to this LIST portlet and return it. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
name + + +string + + + + + + + + column name
type + + +string + + + + + + + + column type
label + + +string + + + + + + + + column label
align + + +string + + + + + + <optional>
+ + + + 		column alignment
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

addEditColumn(column, showView, showHref) → {nlobjColumn}

+ + +
+
+ + +
+ add an Edit column (nlobjColumn) to the left of the column specified (supported on LIST portlets only). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
column + + +nlobjColumn + + + + + + + +
showView + + +boolean + + + + + + + + should Edit|View instead of Edit link
showHref + + +string + + + + + + <optional>
+ + + + 		column that evaluates to T or F that determines whether to disable the edit|view link per-row.
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjColumn + + +
+
+ + + + +
+ + + +
+

addField(name, type, label, source) → {nlobjField}

+ + +
+
+ + +
+ add a field (nlobjField) to this FORM portlet and return it. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
name + + +string + + + + + + + + field name
type + + +string + + + + + + + + field type
label + + +string + + + + + + <optional>
+ + + + 		field label
source + + +string, int + + + + + + <optional>
+ + + + 		script ID or internal ID for source list (select and multiselects only) -or- radio value for radio fields
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

addLine(text, url, indent)

+ + +
+
+ + +
+ add a line (containing text or simple HTML) with optional indenting and URL to this LINKS portlet. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
text + + +string + + + + + + + + data to output to line
url + + +string + + + + + + <optional>
+ + + + 		URL if this line should be clickable (if NULL then line will not be clickable)
indent + + +int + + + + + + + + # of indents to insert before text
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

addRow(row)

+ + +
+
+ + +
+ add a row (nlobjSearchResult or Array of name-value pairs) to this LIST portlet. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
row + + +string[] +| + +nlobjSearchResult + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

addRows(rows)

+ + +
+
+ + +
+ add multiple rows (Array of nlobjSearchResults or name-value pair Arrays) to this LIST portlet. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rows + + +string[][] +| + +nlobjSearchResult[] + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setHtml(html)

+ + +
+
+ + +
+ set the entire contents of the HTML portlet (will be placed inside a ...). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
html + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setSubmitButton(url, label)

+ + +
+
+ + +
+ add a FORM submit button to this FORM portlet. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
url + + +string + + + + + + + + URL that this form portlet will POST to
label + + +string + + + + + + <optional>
+ + + + 		label for submit button (defaults to Save)
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setTitle(title)

+ + +
+
+ + +
+ set the portlet title. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
title + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjRecord.html b/doc/netsuite/nlobjRecord.html new file mode 100644 index 0000000..7c45710 --- /dev/null +++ b/doc/netsuite/nlobjRecord.html @@ -0,0 +1,5747 @@ + + + + + JSDoc: Class: nlobjRecord + + + + + + + + + + +
+ +

Class: nlobjRecord

+ + + + + +
+ +
+

+ nlobjRecord +

+ +
+ +
+
+ + + + +
+

new nlobjRecord() → {nlobjRecord}

+ + +
+
+ + +
+ Return a new instance of nlobjRecord used for accessing and manipulating record objects. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjRecord + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

commitLineItem(group) → {void}

+ + +
+
+ + +
+ Commit the current line in a sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

findLineItemMatrixValue(group, fldnam, column, value) → {int}

+ + +
+
+ + +
+ Return line number for 1st occurence of field value in a sublist column. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
column + + +int + + + + matrix column index (1-based)
value + + +string + + + + matrix field value
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

findLineItemValue(group, fldnam, value) → {int}

+ + +
+
+ + +
+ Return line number for 1st occurence of field value in a sublist column. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
fldnam + + +string + + + + sublist field name
value + + +string + + + + sublist field value
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getAllFields() → {string[]}

+ + +
+
+ + +
+ Return an Array of all field names on the record. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getAllLineItemFields(group) → {string[]}

+ + +
+
+ + +
+ Return an Array of all field names on a record for a particular sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getCurrentLineItemMatrixValue(group, name, column) → {string}

+ + +
+
+ + +
+ Return the current value of a sublist matrix field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + matrix sublist name
name + + +string + + + + matrix field name
column + + +int + + + + matrix field column index (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getCurrentLineItemText(group, name) → {string}

+ + +
+
+ + +
+ Return the current display value of a sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
name + + +string + + + + sublist field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getCurrentLineItemValue(group, name) → {string}

+ + +
+
+ + +
+ Return the current value of a sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
name + + +string + + + + sublist field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getField(fldnam) → {nlobjField}

+ + +
+
+ + +
+ Return field metadata for field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

getFieldText(name) → {string}

+ + +
+
+ + +
+ Return the display value for a select field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getFieldTexts(name) → {string[]}

+ + +
+
+ + +
+ Return the selected display values of a multi-select field as an Array. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getFieldValue(name) → {string}

+ + +
+
+ + +
+ Return the value of a field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getFieldValues(name) → {string[]}

+ + +
+
+ + +
+ Return the selected values of a multi-select field as an Array. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getId() → {int}

+ + +
+
+ + +
+ Return the internalId of the record or NULL for new records. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ Return the integer value of the record ID. +
+ + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getLineItemCount(group)

+ + +
+
+ + +
+ Return the number of lines in a sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

getLineItemField(type, fldnam, linenum) → {nlobjField}

+ + +
+
+ + +
+ Return metadata for sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + sublist name
fldnam + + +string + + + + + + + + sublist field name
linenum + + +int + + + + + + <optional>
+ + + + 		line number (1-based). If empty, the current sublist field is returned. only settable for sublists of type list
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

getLineItemMatrixField(type, fldnam, linenum, linenum) → {nlobjField}

+ + +
+
+ + +
+ Return metadata for sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + matrix sublist name
fldnam + + +string + + + + matrix field name
linenum + + +int + + + + line number
linenum + + +column + + + + matrix column (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

getLineItemText(group, name, line) → {string}

+ + +
+
+ + +
+ Return the text value of a sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
name + + +string + + + + sublist field name
line + + +int + + + + line number (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getLineItemValue(group, name, line)

+ + +
+
+ + +
+ Return the value of a sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
name + + +string + + + + sublist field name
line + + +int + + + + line number (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

getMatrixCount(group, name) → {int}

+ + +
+
+ + +
+ Return the number of columns for a matrix field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + matrix sublist name
name + + +string + + + + matrix field name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getMatrixField(type, fldnam, linenum) → {nlobjField}

+ + +
+
+ + +
+ Return field metadata for field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + matrix sublist name
fldnam + + +string + + + + matrix field name
linenum + + +column + + + + matrix column (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

getMatrixValue(type, name, column) → {string}

+ + +
+
+ + +
+ Get the value of a matrix header field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + matrix sublist name
name + + +string + + + + matrix field name
column + + +int + + + + matrix column index (1-based)
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getRecordType() → {string}

+ + +
+
+ + +
+ Return the recordType corresponding to this record. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + +
+ The string value of the record name internal ID +
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getSubList(type) → {nlobjSubList}

+ + +
+
+ + +
+ Return sublist metadata for sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSubList + + +
+
+ + + + +
+ + + +
+

insertLineItem(group, line)

+ + +
+
+ + +
+ Insert a new line into a sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
group + + +string + + + + + + + + sublist name
line + + +int + + + + + + <optional>
+ + + + 		line index at which to insert line
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

removeLineItem(group, line)

+ + +
+
+ + +
+ Remove an existing line from a sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
group + + +string + + + + + + + + sublist name
line + + +int + + + + + + <optional>
+ + + + 		line number to remove
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

selectLineItem(group, line) → {void}

+ + +
+
+ + +
+ Select an existing line in a sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
line + + +int + + + + line number to select
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

selectNewLineItem(group) → {void}

+ + +
+
+ + +
+ Insert and select a new line in a sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setCurrentLineItemMatrixValue(group, name, column, value) → {void}

+ + +
+
+ + +
+ Set the current value of a sublist matrix field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + matrix sublist name
name + + +string + + + + matrix field name
column + + +int + + + + matrix field column index (1-based)
value + + +string + + + + matrix field value
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setCurrentLineItemValue(group, name, value) → {void}

+ + +
+
+ + +
+ Set the current value of a sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
name + + +string + + + + sublist field name
value + + +string + + + + sublist field value
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setFieldText(name, text) → {void}

+ + +
+
+ + +
+ Set the value (via display value) of a select field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
text + + +string + + + + field display value
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setFieldTexts(name, texts) → {void}

+ + +
+
+ + +
+ Set the values (via display values) of a multi-select field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
texts + + +string[] + + + + array of field display values
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setFieldValue(name, value) → {void}

+ + +
+
+ + +
+ Set the value of a field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
value + + +string + + + + field value
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setFieldValues(name, values)

+ + +
+
+ + +
+ Set the values of a multi-select field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + field name
values + + +string[] + + + + string array containing field values
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setLineItemValue(group, name, line, value)

+ + +
+
+ + +
+ Set the value of a sublist field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
name + + +string + + + + sublist field name
line + + +int + + + + line number (1-based)
value + + +string + + + + sublist field value
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setMatrixValue(type, name, column, value) → {void}

+ + +
+
+ + +
+ Set the value of a matrix header field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + matrix sublist name
name + + +string + + + + matrix field name
column + + +int + + + + matrix column index (1-based)
value + + +string + + + + field value
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjRequest.html b/doc/netsuite/nlobjRequest.html new file mode 100644 index 0000000..5a8776c --- /dev/null +++ b/doc/netsuite/nlobjRequest.html @@ -0,0 +1,1533 @@ + + + + + JSDoc: Class: nlobjRequest + + + + + + + + + + +
+ +

Class: nlobjRequest

+ + + + + +
+ +
+

+ nlobjRequest +

+ +
+ +
+
+ + + + +
+

new nlobjRequest() → {nlobjRequest}

+ + +
+
+ + +
+ Return a new instance of nlobjRequest used for scripting web requests in Suitelets +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjRequest + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

getAllFiles() → {Object}

+ + +
+
+ + +
+ return an Object containing field names to file objects for all uploaded files. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + +
+ + + +
+

getAllHeaders() → {Object}

+ + +
+
+ + +
+ return an Object containing all the request headers and their values. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + +
+ + + +
+

getAllParameters() → {Object}

+ + +
+
+ + +
+ return an Object containing all the request parameters and their values. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + +
+ + + +
+

getBody() → {string}

+ + +
+
+ + +
+ return the body of the POST request +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getFile(name) → {nlobjFile}

+ + +
+
+ + +
+ return the value of an uploaded file. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + file field name
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjFile + + +
+
+ + + + +
+ + + +
+

getHeader(name) → {string}

+ + +
+
+ + +
+ return the value of a request header. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getLineItemCount(group) → {int}

+ + +
+
+ + +
+ return the number of lines in a sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getLineItemValue(group, name, line) → {string}

+ + +
+
+ + +
+ return the value of a sublist value. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
name + + +string + + + + sublist field name
line + + +int + + + + sublist line number
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getMethod() → {string}

+ + +
+
+ + +
+ return the METHOD of the request +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getParameter(name) → {string}

+ + +
+
+ + +
+ return the value of a request parameter. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + parameter name
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getParameterValues(name) → {string[]}

+ + +
+
+ + +
+ return the values of a request parameter as an Array. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + parameter name
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getURL() → {string}

+ + +
+
+ + +
+ return the URL of the request +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjResponse.html b/doc/netsuite/nlobjResponse.html new file mode 100644 index 0000000..41a228a --- /dev/null +++ b/doc/netsuite/nlobjResponse.html @@ -0,0 +1,1768 @@ + + + + + JSDoc: Class: nlobjResponse + + + + + + + + + + +
+ +

Class: nlobjResponse

+ + + + + +
+ +
+

+ nlobjResponse +

+ +
+ +
+
+ + + + +
+

new nlobjResponse() → {nlobjResponse}

+ + +
+
+ + +
+ Return a new instance of nlobjResponse used for scripting web responses in Suitelets +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjResponse + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

addHeader(name, value) → {void}

+ + +
+
+ + +
+ add a value for a response header. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + of header
value + + +string + + + + for header
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

getAllHeaders() → {Object}

+ + +
+
+ + +
+ return an Array of all response headers +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + +
+ + + +
+

getHeader(name) → {string}

+ + +
+
+ + +
+ return the value of a response header. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + of header
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getHeaders(name) → {string[]}

+ + +
+
+ + +
+ return an Array of all response header values for a header +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + of header
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

sendNoCache() → {void}

+ + +
+
+ + +
+ suppress caching for this response. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

sendRedirect(type, subtype, id, pagemode, parameters) → {void}

+ + +
+
+ + +
+ sets the redirect URL for the response. all URLs must be internal unless the Suitelet is being executed in an "Available without Login" context + at which point it can use type "external" to specify an external url via the subtype arg +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
type + + +string + + + + + + + + type specifier for URL: suitelet|tasklink|record|mediaitem|external
subtype + + +string + + + + + + + + subtype specifier for URL (corresponding to type): scriptid|taskid|recordtype|mediaid|url
id + + +string + + + + + + <optional>
+ + + + 		internal ID specifier (sub-subtype corresponding to type): deploymentid|n/a|recordid|n/a
pagemode + + +string + + + + + + <optional>
+ + + + 		string specifier used to configure page (suitelet: external|internal, tasklink|record: edit|view)
parameters + + +Object + + + + + + <optional>
+ + + + 		Object used to specify additional URL parameters as name/value pairs
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setContentType(type, filename, disposition) → {void}

+ + +
+
+ + +
+ sets the content type for the response (and an optional filename for binary output). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + + the file type i.e. plainText, word, pdf, htmldoc (see list of media item types)
filename + + +string + + + + the file name
disposition + + +string + + + + Content Disposition used for streaming attachments: inline|attachment
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setHeader(name, value) → {void}

+ + +
+
+ + +
+ set the value of a response header. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + of header
value + + +string + + + + for header
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

write(output) → {void}

+ + +
+
+ + +
+ write information (text/xml/html) to the response. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
output + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

writeLine(output) → {void}

+ + +
+
+ + +
+ write line information (text/xml/html) to the response. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
output + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

writePage(pageobject) → {void}

+ + +
+
+ + +
+ write a UI object page. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
pageobject + + +Object + + + + page UI object: nlobjList|nlobjAssistant|nlobjForm|nlobjDashboard
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjSearchColumn.html b/doc/netsuite/nlobjSearchColumn.html new file mode 100644 index 0000000..fd010ba --- /dev/null +++ b/doc/netsuite/nlobjSearchColumn.html @@ -0,0 +1,828 @@ + + + + + JSDoc: Class: nlobjSearchColumn + + + + + + + + + + +
+ +

Class: nlobjSearchColumn

+ + + + + +
+ +
+

+ nlobjSearchColumn +

+ +
+ +
+
+ + + + +
+

new nlobjSearchColumn(name, join, summary) → {nlobjSearchColumn}

+ + +
+
+ + +
+ Return a new instance of nlobjSearchColumn used for column objects used to define search return columns. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + column name.
join + + +string + + + + internal ID for joined search where this column is defined
summary + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSearchColumn + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

getFormula() → {string}

+ + +
+
+ + +
+ return formula for this search column. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getJoin() → {string}

+ + +
+
+ + +
+ return the join id for this search column. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getLabel() → {string}

+ + +
+
+ + +
+ return the label of this search column. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getName() → {string}

+ + +
+
+ + +
+ return the name of this search column. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getSummary() → {string}

+ + +
+
+ + +
+ return the summary type (avg,group,sum,count) of this search column. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

setSort(sort) → {nlobjSearchColumn}

+ + +
+
+ + +
+ return nlobjSearchColumn sorted in either ascending or descending order. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
sort + + +boolean + + + + if not set, defaults to false, which returns column data in ascending order.
+ + + +
+ + + + + +
Since:
+
  • 2010.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSearchColumn + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjSearchFilter.html b/doc/netsuite/nlobjSearchFilter.html new file mode 100644 index 0000000..ddf7cdd --- /dev/null +++ b/doc/netsuite/nlobjSearchFilter.html @@ -0,0 +1,571 @@ + + + + + JSDoc: Class: nlobjSearchFilter + + + + + + + + + + +
+ +

Class: nlobjSearchFilter

+ + + + + +
+ +
+

+ nlobjSearchFilter +

+ +
+ +
+
+ + + + +
+

new nlobjSearchFilter(name, join, operator, value, value2) → {nlobjSearchFilter}

+ + +
+
+ + +
+ Return a new instance of nlobjSearchFilter filter objects used to define search criteria. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + filter name.
join + + +string + + + + internal ID for joined search where this filter is defined
operator + + +string + + + + operator name (i.e. anyOf, contains, lessThan, etc..)
value + + +string +| + +string[] + + + +
value2 + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSearchFilter + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

getJoin() → {string}

+ + +
+
+ + +
+ Return the join id for this search filter. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getName() → {string}

+ + +
+
+ + +
+ Return the name of this search filter. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2007.0
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getOperator() → {string}

+ + +
+
+ + +
+ Return the filter operator used. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjSearchResult.html b/doc/netsuite/nlobjSearchResult.html new file mode 100644 index 0000000..1e85335 --- /dev/null +++ b/doc/netsuite/nlobjSearchResult.html @@ -0,0 +1,1047 @@ + + + + + JSDoc: Class: nlobjSearchResult + + + + + + + + + + +
+ +

Class: nlobjSearchResult

+ + + + + +
+ +
+

+ nlobjSearchResult +

+ +
+ +
+
+ + + + +
+

new nlobjSearchResult() → {nlobjSearchResult}

+ + +
+
+ + +
+ Return a new instance of nlobjSearchResult used for search result row object. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSearchResult + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

getAllColumns() → {nlobjSearchColumn[]}

+ + +
+
+ + +
+ return an array of all nlobjSearchColumn objects returned in this search. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSearchColumn[] + + +
+
+ + + + +
+ + + +
+

getId() → {int}

+ + +
+
+ + +
+ return the internalId for the record returned in this row. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getRecordType() → {string}

+ + +
+
+ + +
+ return the recordtype for the record returned in this row. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getText(column) → {string}

+ + +
+
+ + +
+ return the text value for this nlobjSearchColumn if it's a select field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
column + + +nlobjSearchColumn + + + + search result column
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getText(name, join, summary) → {string}

+ + +
+
+ + +
+ return the text value of this return column if it's a select field. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + the name of the search column
join + + +string + + + + the join ID for the search column
summary + + +string + + + + summary type specified for this column
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getValue(column) → {string}

+ + +
+
+ + +
+ return the value for this nlobjSearchColumn. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
column + + +nlobjSearchColumn + + + + search result column
+ + + +
+ + + + + +
Since:
+
  • 2009.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getValue(name, join, summary) → {string}

+ + +
+
+ + +
+ return the value for a return column specified by name, join ID, and summary type. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + the name of the search column
join + + +string + + + + the join ID for the search column
summary + + +string + + + + summary type specified for this column
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjSelectOption.html b/doc/netsuite/nlobjSelectOption.html new file mode 100644 index 0000000..a4ffb4b --- /dev/null +++ b/doc/netsuite/nlobjSelectOption.html @@ -0,0 +1,342 @@ + + + + + JSDoc: Class: nlobjSelectOption + + + + + + + + + + +
+ +

Class: nlobjSelectOption

+ + + + + +
+ +
+

+ nlobjSelectOption +

+ +
+ +
+
+ + + + +
+

new nlobjSelectOption() → {nlobjSelectOption}

+ + +
+
+ + +
+ Return a new instance of nlobjSelectOption. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSelectOption + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

getId() → {string}

+ + +
+
+ + +
+ return internal ID for select option +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getText() → {string}

+ + +
+
+ + +
+ return display value for select option. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjServerResponse.html b/doc/netsuite/nlobjServerResponse.html new file mode 100644 index 0000000..a479189 --- /dev/null +++ b/doc/netsuite/nlobjServerResponse.html @@ -0,0 +1,868 @@ + + + + + JSDoc: Class: nlobjServerResponse + + + + + + + + + + +
+ +

Class: nlobjServerResponse

+ + + + + +
+ +
+

+ nlobjServerResponse +

+ +
+ +
+
+ + + + +
+

new nlobjServerResponse() → {nlobjServerResponse}

+ + +
+
+ + +
+ Return a new instance of nlobjServerResponse.. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjServerResponse + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

getAllHeaders() → {string[]}

+ + +
+
+ + +
+ return an Array of all headers returned. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ + + +
+

getBody() → {string}

+ + +
+
+ + +
+ return the response body returned. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getCode() → {int}

+ + +
+
+ + +
+ return the response code returned. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +int + + +
+
+ + + + +
+ + + +
+

getContentType() → {string}

+ + +
+
+ + +
+ return the Content-Type header in response +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getError() → {nlobjError}

+ + +
+
+ + +
+ return the nlobjError thrown via a client call to nlapiRequestURL. +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjError + + +
+
+ + + + +
+ + + +
+

getHeader(name) → {string}

+ + +
+
+ + +
+ return the value of a header returned. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + the name of the header to return
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + +
+
+ + + + +
+ + + +
+

getHeaders(name) → {string[]}

+ + +
+
+ + +
+ return all the values of a header returned. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + the name of the header to return
+ + + +
+ + + + + +
Since:
+
  • 2008.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string[] + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjSubList.html b/doc/netsuite/nlobjSubList.html new file mode 100644 index 0000000..a51afe0 --- /dev/null +++ b/doc/netsuite/nlobjSubList.html @@ -0,0 +1,1816 @@ + + + + + JSDoc: Class: nlobjSubList + + + + + + + + + + +
+ +

Class: nlobjSubList

+ + + + + +
+ +
+

+ nlobjSubList +

+ +
+ +
+
+ + + + +
+

new nlobjSubList() → {nlobjSubList}

+ + +
+
+ + +
+ Return a new instance of nlobjSubList used for scriptable sublist (sublist). +This object is READ-ONLY except for instances created via the UI Object API using Suitelets or beforeLoad user events. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjSubList + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

addButton(name, label, script) → {nlobjButton}

+ + +
+
+ + +
+ add a button to this sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + button name
label + + +string + + + + button label
script + + +string + + + + button script (function name)
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjButton + + +
+
+ + + + +
+ + + +
+

addField(name, type, label, source) → {nlobjField}

+ + +
+
+ + +
+ add a field (column) to this sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
name + + +string + + + + + + + + field name
type + + +string + + + + + + + + field type
label + + +string + + + + + + + + field label
source + + +string, int + + + + + + <optional>
+ + + + 		script ID or internal ID for source list used for this select field
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ + + +
+

addMarkAllButtons()

+ + +
+
+ + +
+ add "Mark All" and "Unmark All" buttons to this sublist of type "list". +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

addRefreshButton() → {nlobjButton}

+ + +
+
+ + +
+ add "Refresh" button to sublists of type "staticlist" to support manual refreshing of the sublist (without entire page reloads) if it's contents are very volatile +
+ + + + + + + + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjButton + + +
+
+ + + + +
+ + + +
+

getLineItemCount(group)

+ + +
+
+ + +
+ Return the number of lines in a sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
group + + +string + + + + sublist name
+ + + +
+ + + + + +
Since:
+
  • 2010.1
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setDisplayType(type)

+ + +
+
+ + +
+ set the displaytype for this sublist: hidden|normal. +This method is only supported on scripted or staticlist sublists via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setHelpText(help)

+ + +
+
+ + +
+ set helper text for this sublist. +This method is only supported on sublists via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
help + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setLabel(label)

+ + +
+
+ + +
+ set the label for this sublist. +This method is only supported on sublists via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
label + + +string + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setLineItemMatrixValue(field, line, column, value) → {void}

+ + +
+
+ + +
+ set the value of a matrix cell in this sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
field + + +string + + + + matrix field name
line + + +int + + + + line number (1-based)
column + + +int + + + + matrix column index (1-based)
value + + +string + + + + matrix field value
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + +
+ + + +
+

setLineItemValue(field, line, value)

+ + +
+
+ + +
+ set the value of a cell in this sublist. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
field + + +string + + + + sublist field name
line + + +int + + + + line number (1-based)
value + + +string + + + + sublist value
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setLineItemValues(values)

+ + +
+
+ + +
+ set values for multiple lines (Array of nlobjSearchResults or name-value pair Arrays) in this sublist. +Note that this method is only supported on scripted sublists via the UI Object API +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
values + + +string[][], nlobjSearchResult[] + + + +
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
+ + + +
+

setUniqueField(fldnam) → {nlobjField}

+ + +
+
+ + +
+ designate a field on sublist that must be unique across all lines (only supported on sublists of type inlineeditor, editor). +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
fldnam + + +string + + + + the name of a field on this sublist whose value must be unique across all lines
+ + + +
+ + + + + +
Since:
+
  • 2009.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjField + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/nlobjTab.html b/doc/netsuite/nlobjTab.html new file mode 100644 index 0000000..b7df12f --- /dev/null +++ b/doc/netsuite/nlobjTab.html @@ -0,0 +1,435 @@ + + + + + JSDoc: Class: nlobjTab + + + + + + + + + + +
+ +

Class: nlobjTab

+ + + + + +
+ +
+

+ nlobjTab +

+ +
+ +
+
+ + + + +
+

new nlobjTab() → {nlobjTab}

+ + +
+
+ + +
+ Return a new instance of nlobjTab used for scriptable tab or subtab. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjTab + + +
+
+ + + + +
+ + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+

setHelpText(help) → {nlobjTab}

+ + +
+
+ + +
+ set helper text for this tab or subtab. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
help + + +string + + + + inline help text used for this tab or subtab
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjTab + + +
+
+ + + + +
+ + + +
+

setLabel(label) → {nlobjTab}

+ + +
+
+ + +
+ set the label for this tab or subtab. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
label + + +string + + + + string used as label for this tab or subtab
+ + + +
+ + + + + +
Since:
+
  • 2008.2
+ + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +nlobjTab + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + diff --git a/doc/netsuite/scripts/prettify/Apache-License-2.0.txt b/doc/netsuite/scripts/prettify/Apache-License-2.0.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/doc/netsuite/scripts/prettify/Apache-License-2.0.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/doc/netsuite/scripts/prettify/lang-css.js b/doc/netsuite/scripts/prettify/lang-css.js new file mode 100644 index 0000000..041e1f5 --- /dev/null +++ b/doc/netsuite/scripts/prettify/lang-css.js @@ -0,0 +1,2 @@ +PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com", +/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]); diff --git a/doc/netsuite/scripts/prettify/prettify.js b/doc/netsuite/scripts/prettify/prettify.js new file mode 100644 index 0000000..eef5ad7 --- /dev/null +++ b/doc/netsuite/scripts/prettify/prettify.js @@ -0,0 +1,28 @@ +var q=null;window.PR_SHOULD_USE_CONTINUATION=!0; +(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a= +[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m), +l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/, +q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/, +q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g, +"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a), +a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e} +for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"], +"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"], +H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"], +J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+ +I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]), +["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css", +/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}), +["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes", +hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b= +!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p + + + + JSDoc: Source: netsuite_toolkit.js + + + + + + + + + + +
+ +

Source: netsuite_toolkit.js

+ + + + + +
+
+ 
/** @namespace NetsuiteToolkit */
+var NetsuiteToolkit              = {};
+NetsuiteToolkit.RecordProcessor  = {};
+NetsuiteToolkit.SublistProcessor = {};
+
+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.";
+
+/**
+ * Requests a newly initialized record from NetSuite.
+ *
+ * @method
+ * @param {string} record_type The String representing a record type
+ * @memberof NetsuiteToolkit
+ * @return {null}
+ */
+NetsuiteToolkit.initializeRecord = function(record_type) {
+  return nlapiInitializeRecord(record_type);
+}
+
+/**
+ * Requests a record from NetSuite's database by id (internal_id in NetSuite parlance)
+ *
+ * @method
+ * @param {string} record_type The String representing a record type
+ * @param {string} interal_id  The String representing a NetSuite internal_id
+ * @memberof NetsuiteToolkit
+ * @return {null}
+ */
+NetsuiteToolkit.loadRecord = function(record_type, record_id) {
+  return nlapiLoadRecord(record_type, record_id);
+}
+
+NetsuiteToolkit.deleteRecord = function() {}
+
+NetsuiteToolkit.transformRecord = function() {}
+
+/**
+ * Requests that Netsuite write a given record to it's database.
+ *
+ * @method
+ * @param {nlobjRecord} record           The NetSuite record object
+ * @param {boolean}     do_sourcing      Enable or disable sourcing
+ * @param {boolean}     ignore_mandatory Recognize or ignore mandatory fields
+ * @memberof NetsuiteToolkit
+ * @return {null}
+ */
+NetsuiteToolkit.submitRecord = function(record, do_sourcing, ignore_mandatory) {
+  do_sourcing      = do_sourcing      || false;
+  ignore_mandatory = ignore_mandatory || false;
+  return nlapiSubmitRecord(record, do_sourcing, ignore_mandatory);
+}
+
+/**
+* Mutates an arbitrary field value on a NetSuite record.
+*
+* @method
+* @param {nlobjRecord} record     The NetSuite record object 
+* @param {string}      field_name The String representing the field to mutate
+* @param {value}       value      The String representing the value to replace
+* @memberof NetsuiteToolkit
+* @return {null}
+*/
+NetsuiteToolkit.setFieldValue = function(record, field_name, value) {
+  record.setFieldValue(field_name, value);
+}
+
+/**
+ * Fetches the line item count for a given NetSuite sublist.
+ *
+ * @method
+ * @param {nlobjRecord} record       The NetSuite record object 
+ * @param {string}      sublist_name The String representing the NetSuite sublist
+ * @memberof NetsuiteToolkit
+ * @return {number} The line item count for the sublist.
+ */
+NetsuiteToolkit.getLineItemCount = function(record, sublist_name) {
+  return record.getLineItemCount(sublist_name);
+}
+
+/**
+ * Fetched the value of a line item in a given sublist for a given field.
+ *
+ * @method
+ * @param {nlobjRecord} record       The NetSuite record object 
+ * @param {string}      sublist_name The String representing the NetSuite sublist
+ * @param {number}      index        The Number of the sublist index
+ * @param {string}      field_name   The string representing the name of the field
+ * @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);
+}
+
+/**
+ * Mutates the value of a line item in a given sublist for a given field.
+ *
+ * @method
+ * @param {nlobjRecord} record       The NetSuite record object 
+ * @param {string}      sublist_name The String representing the NetSuite sublist
+ * @param {number}      index        The Number of the sublist index
+ * @param {string}      field_name   The string representing the name of the field
+ * @param {string}      value        The string representing the value of the field
+ * @memberof NetsuiteToolkit
+ * @return {null}
+ */
+NetsuiteToolkit.setLineItemValue = function(record, sublist_name, index, field_name, value) {
+  record.setLineItemValue(sublist_name, index, field_name, value);  
+}
+
+/** 
+ * Inserts a line item into a sublist on a given record.
+ * 
+ * @method
+ * @param {nlobjRecord} record       The NetsuiteRecord object
+ * @param {string}      sublist_name The String representing the NetSuite sublist on the record 
+ * @param {number}      index        The Number of the sublist index to be updated
+ * @memberof NetsuiteToolkit
+ * @return {null}
+ */
+NetsuiteToolkit.insertLineItem = function(record, sublist_name, index) {
+  record.insertLineItem(sublist_name, index);
+}
+
+/**
+ * Removes a line item at a given index for a given sublist field.
+ *
+ * @method
+ * @param {nlobjRecord} record       The NetSuite record object
+ * @param {string}      sublist_name The string representing the name of the sublist field
+ * @param {number}      index        The number of the sublist index
+ * @memberof NetsuiteToolkit
+ * @return {null}
+ */
+NetsuiteToolkit.removeLineItem = function(record, sublist_name, index) {
+  record.removeLineItem(sublist_name, index);
+}
+
+/**
+ * Returns a formatted reply object using a given set of params, result and possible exception
+ *
+ * @method
+ * @param {object} params    The object holding the params of a request
+ * @param {object} result    The object containing the result of the request
+ * @param {error}  exception The error object of a raised exception
+ * @memberof NetsuiteToolkit
+ * @return {object} The formatted reply object
+ */
+NetsuiteToolkit.formatReply = function(params, result, exception) {
+  reply = {};
+
+  reply['params']  = params;
+  reply['result']  = result;
+
+  if(exception) {
+    reply['exception'] = NetsuiteToolkit.formatException(exception);
+    reply['success']   = false;
+  } else {
+    reply['success'] = true;
+  }
+
+  return reply;
+}                                                           
+                                                          
+/**
+ * Returns a formatted reply object based off of a given exception.
+ *
+ * @method
+ * @param {error} exception The Error object of the given exception
+ * @memberof NetsuiteToolkit
+ * @return {object} The formatted reply object generated from the exception
+ */
+NetsuiteToolkit.formatException = function(exception) {                 
+  var formattedException = {};
+
+  formattedException['message'] = exception.message;
+
+  try {
+    formattedException['trace'] = exception.getStackTrace();
+  } catch(stack_fetch_error) {
+    formattedException['trace'] = stack_fetch_error.message;
+  }
+
+  return formattedException;
+}
+
+/** @namespace NetsuiteToolkit.RecordProcessor */
+
+/**
+ * Update literal fields on a given record with the given fieldData.
+ *
+ * @method
+ * @param {nlobjRecord} record    The NetSuite record object
+ * @param {object}      fieldData Data for literal fields
+ * @memberof NetsuiteToolkit.RecordProcessor
+ */
+NetsuiteToolkit.RecordProcessor.updateLiterals = function(record, fieldData) {
+  for(field_name in fieldData) {
+    value = fieldData[field_name];
+    NetsuiteToolkit.setFieldValue(record, field_name, value);
+  }
+}
+
+/** @namespace NetsuiteToolkit.SublistProcessor */
+
+/**
+ * SublistProcessor Class
+ * @class NetsuiteToolkit.SublistProcessor
+ * @param {object} sublist_data The object representing operations to be performed
+ *                              on the sublist data
+ * @return {SublistProcessor} The new instance of NetsuiteToolkit.SublistProcessor
+ */
+NetsuiteToolkit.SublistProcessor = (function() {
+
+  /* @constructor */
+  function SublistProcessor(record, sublist_data) {
+    this.record       = record;
+    this.sublist_name = sublist_data['name'];
+    this.create_list  = sublist_data['create'] || [];
+    this.update_list  = sublist_data['update'] || [];
+    this.excise_list  = sublist_data['excise'] || [];
+  }
+
+  /**
+   * Procedural function to execute all sublist operations on the given
+   * record and sublist
+   *
+   * @method
+   * @memberof NetsuiteToolkit.SublistProcessor
+   */
+  SublistProcessor.prototype.execute = function() {
+    this.processCreations();
+    this.processUpdates();
+    this.processExcisions();
+  }
+
+  /**
+   * Iterate over list of creation requests and execute them
+   * 
+   * @method
+   * @memberof NetsuiteToolkit.SublistProcessor
+   */
+  SublistProcessor.prototype.processCreations = function() {
+    for(index in this.create_list) {
+      create_request = this.create_list[index];
+      this.createLineItem(create_request);
+    }
+  }
+
+  /**
+   * Iterate over list of update requests and execute them
+   * 
+   * @method
+   * @memberof NetsuiteToolkit.SublistProcessor
+   */
+  SublistProcessor.prototype.processUpdates = function() {
+    for(index in this.update_list) {
+      update_request = this.update_list[index];
+      this.updateLineItem(update_request);
+    }
+  }
+
+  /**
+   * Iterate over list of excision requests and execute them
+   * 
+   * @method
+   * @memberof NetsuiteToolkit.SublistProcessor
+   */
+  SublistProcessor.prototype.processExcisions = function() {
+    for(index in this.excise_list) {
+      excise_request = this.excise_list[index];
+      this.exciseLineItem(excise_request);
+    }
+  }
+
+  /**
+   * Creates and alters the fields of a new line item using the
+   * given params
+   * 
+   * @method
+   * @param {object} creation_request The Object that hold a single creation
+   *                                  request for a line item
+   * @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);
+  }
+
+  /**
+   * Alters the fields of a line item using the given params
+   * 
+   * @method
+   * @param {object} update_request The Object that hold a single update
+   *                                request for a line item
+   * @memberof NetsuiteToolkit.SublistProcessor
+   */
+  SublistProcessor.prototype.updateLineItem = function(update_request) {
+    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);
+    }
+
+    this.updateLineItemFields(index, data);
+  };
+
+  /**
+   * Removes a line item using the given params
+   * 
+   * @method
+   * @param {object} excise_request The Object that hold a single excise
+   *                                request for a line item
+   * @memberof NetsuiteToolkit.SublistProcessor
+   */
+  SublistProcessor.prototype.exciseLineItem = function(excise_request) {
+    index = excise_request['index'];
+    match = excise_request['match'];
+    data  = excise_request['data'];
+
+    if(!index && !match) {
+      throw NetsuiteToolkit.SublistProcessor.UnableToMatch;
+    } else if(!index) {
+      index = this.matchLineItemByField(match, data);
+    }
+
+    NetsuiteToolkit.removeLineItem(this.record, this.sublist_name, index);
+  }
+
+  /**
+   * Updates all declared fields of a line item at the given index
+   *
+   * @param {Number} index          The Number representing the index position of
+   *                                a line item
+   * @param {object} line_item_data The Object representing the fields and values
+   *                                for a line item alteration
+   * @memberof NetsuiteToolkit.SublistProcessor
+   */
+  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, index, field, value);
+    }
+  }
+
+  /**
+   * Locates the index of a line item matching the given field data, returns
+   * the first match encountered. An exception is raised if no match is found
+   *
+   * @param {String} match_field The String representing the internalid of a line item
+   *                             field
+   * @param {object} data        The Object representing the line item field and value
+   *                             data
+   * @memberof NetsuiteToolkit.SublistProcessor
+   * @return {Number} The Number representing the index of the mateched line item
+   */
+  SublistProcessor.prototype.matchLineItemByField = function(match_field, data) {
+    match_value = data[match_field];
+    count       = NetsuiteToolkit.getLineItemCount(this.record, this.sublist_name);
+
+    for(index=1; index <= count; index++) {
+      if(this.compareLineItemValue(index, match_field, match_value)) { return index }
+    }
+
+    throw NetsuiteToolkit.SublistProcessor.UnableToMatch;
+  }
+
+  /**
+   * Compares the value of a given field at a given line item index with the
+   * given value
+   *
+   * @param {Number} index       The Number representing the index position of the line item
+   * @param {String} match_field The String representing the internalid of the line item field
+   * @param {String} match_value The String representing the value to be compared against
+   * @memberof NetsuiteToolkit.SublistProcessor
+   * @return {Boolean} The Boolean representing the successful match
+   */
+  SublistProcessor.prototype.compareLineItemValue = function(index, match_field, match_value) {
+    netsuite_value = NetsuiteToolkit.getLineItemValue(this.record, this.sublist_name,
+                                                      index, match_field);
+    return (netsuite_value == match_value);
+  }
+
+  return SublistProcessor;
+})();
+
+/**
+ * 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);
+
+/**
+ * An exception thrown in the event that a line item cannot be matched
+ * to a given field.
+ * @static
+ * @field
+ * @memberof NetsuiteToolkit.SublistProcessor
+ */
+NetsuiteToolkit.SublistProcessor.UnableToMatch = new Error(line_item_match_error);
+
+exports.NetsuiteToolkit = NetsuiteToolkit;
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.1.1 on Mon May 13 2013 09:15:19 GMT-0500 (CDT) +
+ + + + diff --git a/doc/scripts/prettify/Apache-License-2.0.txt b/doc/scripts/prettify/Apache-License-2.0.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/doc/scripts/prettify/Apache-License-2.0.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/doc/scripts/prettify/lang-css.js b/doc/scripts/prettify/lang-css.js new file mode 100644 index 0000000..041e1f5 --- /dev/null +++ b/doc/scripts/prettify/lang-css.js @@ -0,0 +1,2 @@ +PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com", +/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]); diff --git a/doc/scripts/prettify/prettify.js b/doc/scripts/prettify/prettify.js new file mode 100644 index 0000000..eef5ad7 --- /dev/null +++ b/doc/scripts/prettify/prettify.js @@ -0,0 +1,28 @@ +var q=null;window.PR_SHOULD_USE_CONTINUATION=!0; +(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a= +[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m), +l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/, +q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/, +q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g, +"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a), +a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e} +for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"], +"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"], +H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"], +J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+ +I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]), +["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css", +/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}), +["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes", +hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b= +!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p + + + + JSDoc: Source: upsert.js + + + + + + + + + + +
+ +

Source: upsert.js

+ + + + + +
+
+ 
//NOTE (nilmethod) document the glue method that NetSuite will host
+
+/**
+ * Upserter Class
+ * @class Upserter
+ * @param {object} request The body of the HTTP Post request from the client
+ * @return {Upserter} A new instance of Upserter
+ */
+this.Upserter = (function() {
+
+  /** @constructor */
+  // FIXME (JamesChristie+nilmethod) document post body input
+  function Upserter(request) {
+    this.params      = request;
+    this.record_data = request['record_data'];
+    this.reply_list  = [];
+    this.exception   = null;
+  }
+
+  /**
+   * Generate a body for the reply to the client's request.
+   *
+   * @method
+   * @memberof Upserter
+   * @return {object} The object containing a formatted summary of the results of the request
+   */
+  Upserter.prototype.generateReply = function() {
+    return NetsuiteToolkit.formatReply(this.params, this.replyList);
+  }
+
+  return Upserter;
+})();
+
+/**
+ * UpsertRequest Class
+ * @class UpsertRequest
+ * @param {object} record_data The data from a client request
+ * @return {Loader} A new instance of UpsertRequest
+ */
+this.UpsertRequest = (function() {
+
+  /** @constructor */
+  function UpsertRequest(record_data) {
+    this.params     = record_data;
+    this.record     = null;
+    this.written_id = null;
+
+    this.internalid         = record_data['internalid'] || null;
+    this.record_type        = record_data['record_type'];
+    this.literal_field_data = record_data['literal_fields'];
+    this.sublist_data       = record_data['sublists'];
+  }
+
+  /**
+   * Performs the UpsertRequest
+   *
+   * @method
+   * @memberof UpsertRequest
+   * @return {null}
+   */
+  UpsertRequest.prototype.execute = function() {
+    this.record = this.loadOrInitializeRecord();
+    NetsuiteToolkit.RecordProcessor.updateLiterals(this.record, this.literal_field_data);
+    this.processSublists();
+  }
+
+  /**
+   * Finds or creates a new record based on the presence of `internalid`
+   * 
+   * @method
+   * @memberof UpsertRequest
+   * @return {null}
+   */
+  UpsertRequest.prototype.loadOrInitializeRecord = function() {
+    if(this.internalid) {
+      this.record = NetsuiteToolkit.loadRecord(this.record_type, this.internalid);
+    } else {
+      this.record = NetsuiteToolkit.initializeRecord(this.record_type);
+    }
+  }
+
+  /**
+   * Iterates through given sublists calling `executeSublistProcessor()`
+   * 
+   * @method
+   * @memberof UpsertRequest
+   * @return {null}
+   */
+  UpsertRequest.prototype.processSublists = function() {
+    for(index in this.sublist_data) {
+      sublist = this.sublist_data[index];
+      this.executeSublistProcessor(sublist);
+    }
+  }
+
+  /**
+   * Initializes and calls `execute()` on the `NetsuiteToolkit.SublistProcessor()`
+   * 
+   * @method
+   * @memberof UpsertRequest
+   * @return {null}
+   */
+  UpsertRequest.prototype.executeSublistProcessor = function(sublist_data) {
+    sublist_processor = new NetsuiteToolkit.SublistProcessor(this.record, sublist_data);
+    sublist_processor.execute();
+  }
+
+  /**
+   * Calls `NetsuiteToolkit.formatReply()` passing it `params` and `written_id`
+   * 
+   * @method
+   * @memberof UpsertRequest
+   * @return {object} Formatted reply
+   */
+  UpsertRequest.prototype.generateReply = function() {
+    return NetsuiteToolkit.formatReply(this.params, this.written_id);
+  }
+
+  return UpsertRequest;
+})();
+
+var postHandler = function(request) {
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.1.1 on Mon May 13 2013 09:15:19 GMT-0500 (CDT) +
+ + + + diff --git a/jspec b/jspec index cc6e1e9..215d839 100755 --- a/jspec +++ b/jspec @@ -11,6 +11,7 @@ fi if [[ $@ =~ "--doc" ]]; then echo "Generating documentation..." node_modules/jsdoc/./jsdoc -l -d doc/ ./lib/*.js README.md + node_modules/jsdoc/./jsdoc -l -d doc/netsuite ./doc/netsuite/*.js ./doc/netsuite/README.md exit fi @@ -37,4 +38,4 @@ if [[ $@ =~ "--debug" ]]; then node debug ./node_modules/jasmine-node/bin/jasmine-node --forceexit spec else ./node_modules/jasmine-node/bin/jasmine-node --forceexit spec -fi \ No newline at end of file +fi diff --git a/lib/load.js b/lib/load.js index d20b309..dab7342 100644 --- a/lib/load.js +++ b/lib/load.js @@ -7,6 +7,7 @@ this.Loader = (function() { /** @constructor */ + // FIXME (JamesChristie+nilmethod) document post body input function Loader(request) { this.params = request; this.result_list = []; diff --git a/lib/netsuite_toolkit.js b/lib/netsuite_toolkit.js index aa19c99..ee901ab 100644 --- a/lib/netsuite_toolkit.js +++ b/lib/netsuite_toolkit.js @@ -1,5 +1,10 @@ /** @namespace NetsuiteToolkit */ -var NetsuiteToolkit = {}; +var NetsuiteToolkit = {}; +NetsuiteToolkit.RecordProcessor = {}; +NetsuiteToolkit.SublistProcessor = {}; + +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."; /** * Requests a newly initialized record from NetSuite. @@ -104,6 +109,20 @@ NetsuiteToolkit.setLineItemValue = function(record, sublist_name, index, field_n record.setLineItemValue(sublist_name, index, field_name, value); } +/** + * Inserts a line item into a sublist on a given record. + * + * @method + * @param {nlobjRecord} record The NetsuiteRecord object + * @param {string} sublist_name The String representing the NetSuite sublist on the record + * @param {number} index The Number of the sublist index to be updated + * @memberof NetsuiteToolkit + * @return {null} + */ +NetsuiteToolkit.insertLineItem = function(record, sublist_name, index) { + record.insertLineItem(sublist_name, index); +} + /** * Removes a line item at a given index for a given sublist field. * @@ -148,7 +167,7 @@ NetsuiteToolkit.formatReply = function(params, result, exception) { * Returns a formatted reply object based off of a given exception. * * @method - * @params {error} exception The Error object of the given exception + * @param {error} exception The Error object of the given exception * @memberof NetsuiteToolkit * @return {object} The formatted reply object generated from the exception */ @@ -166,4 +185,231 @@ NetsuiteToolkit.formatException = function(exception) { return formattedException; } -exports.NetsuiteToolkit = NetsuiteToolkit; \ No newline at end of file +/** @namespace NetsuiteToolkit.RecordProcessor */ + +/** + * Update literal fields on a given record with the given fieldData. + * + * @method + * @param {nlobjRecord} record The NetSuite record object + * @param {object} fieldData Data for literal fields + * @memberof NetsuiteToolkit.RecordProcessor + */ +NetsuiteToolkit.RecordProcessor.updateLiterals = function(record, fieldData) { + for(field_name in fieldData) { + value = fieldData[field_name]; + NetsuiteToolkit.setFieldValue(record, field_name, value); + } +} + +/** @namespace NetsuiteToolkit.SublistProcessor */ + +/** + * SublistProcessor Class + * @class NetsuiteToolkit.SublistProcessor + * @param {object} sublist_data The object representing operations to be performed + * on the sublist data + * @return {SublistProcessor} The new instance of NetsuiteToolkit.SublistProcessor + */ +NetsuiteToolkit.SublistProcessor = (function() { + + /* @constructor */ + function SublistProcessor(record, sublist_data) { + this.record = record; + this.sublist_name = sublist_data['name']; + this.create_list = sublist_data['create'] || []; + this.update_list = sublist_data['update'] || []; + this.excise_list = sublist_data['excise'] || []; + } + + /** + * Procedural function to execute all sublist operations on the given + * record and sublist + * + * @method + * @memberof NetsuiteToolkit.SublistProcessor + */ + SublistProcessor.prototype.execute = function() { + this.processCreations(); + this.processUpdates(); + this.processExcisions(); + } + + /** + * Iterate over list of creation requests and execute them + * + * @method + * @memberof NetsuiteToolkit.SublistProcessor + */ + SublistProcessor.prototype.processCreations = function() { + for(index in this.create_list) { + create_request = this.create_list[index]; + this.createLineItem(create_request); + } + } + + /** + * Iterate over list of update requests and execute them + * + * @method + * @memberof NetsuiteToolkit.SublistProcessor + */ + SublistProcessor.prototype.processUpdates = function() { + for(index in this.update_list) { + update_request = this.update_list[index]; + this.updateLineItem(update_request); + } + } + + /** + * Iterate over list of excision requests and execute them + * + * @method + * @memberof NetsuiteToolkit.SublistProcessor + */ + SublistProcessor.prototype.processExcisions = function() { + for(index in this.excise_list) { + excise_request = this.excise_list[index]; + this.exciseLineItem(excise_request); + } + } + + /** + * Creates and alters the fields of a new line item using the + * given params + * + * @method + * @param {object} creation_request The Object that hold a single creation + * request for a line item + * @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); + } + + /** + * Alters the fields of a line item using the given params + * + * @method + * @param {object} update_request The Object that hold a single update + * request for a line item + * @memberof NetsuiteToolkit.SublistProcessor + */ + SublistProcessor.prototype.updateLineItem = function(update_request) { + 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); + } + + this.updateLineItemFields(index, data); + }; + + /** + * Removes a line item using the given params + * + * @method + * @param {object} excise_request The Object that hold a single excise + * request for a line item + * @memberof NetsuiteToolkit.SublistProcessor + */ + SublistProcessor.prototype.exciseLineItem = function(excise_request) { + index = excise_request['index']; + match = excise_request['match']; + data = excise_request['data']; + + if(!index && !match) { + throw NetsuiteToolkit.SublistProcessor.UnableToMatch; + } else if(!index) { + index = this.matchLineItemByField(match, data); + } + + NetsuiteToolkit.removeLineItem(this.record, this.sublist_name, index); + } + + /** + * Updates all declared fields of a line item at the given index + * + * @param {Number} index The Number representing the index position of + * a line item + * @param {object} line_item_data The Object representing the fields and values + * for a line item alteration + * @memberof NetsuiteToolkit.SublistProcessor + */ + 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, index, field, value); + } + } + + /** + * Locates the index of a line item matching the given field data, returns + * the first match encountered. An exception is raised if no match is found + * + * @param {String} match_field The String representing the internalid of a line item + * field + * @param {object} data The Object representing the line item field and value + * data + * @memberof NetsuiteToolkit.SublistProcessor + * @return {Number} The Number representing the index of the mateched line item + */ + SublistProcessor.prototype.matchLineItemByField = function(match_field, data) { + match_value = data[match_field]; + count = NetsuiteToolkit.getLineItemCount(this.record, this.sublist_name); + + for(index=1; index <= count; index++) { + if(this.compareLineItemValue(index, match_field, match_value)) { return index } + } + + throw NetsuiteToolkit.SublistProcessor.UnableToMatch; + } + + /** + * Compares the value of a given field at a given line item index with the + * given value + * + * @param {Number} index The Number representing the index position of the line item + * @param {String} match_field The String representing the internalid of the line item field + * @param {String} match_value The String representing the value to be compared against + * @memberof NetsuiteToolkit.SublistProcessor + * @return {Boolean} The Boolean representing the successful match + */ + SublistProcessor.prototype.compareLineItemValue = function(index, match_field, match_value) { + netsuite_value = NetsuiteToolkit.getLineItemValue(this.record, this.sublist_name, + index, match_field); + return (netsuite_value == match_value); + } + + return SublistProcessor; +})(); + +/** + * 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); + +/** + * An exception thrown in the event that a line item cannot be matched + * to a given field. + * @static + * @field + * @memberof NetsuiteToolkit.SublistProcessor + */ +NetsuiteToolkit.SublistProcessor.UnableToMatch = new Error(line_item_match_error); + +exports.NetsuiteToolkit = NetsuiteToolkit; diff --git a/lib/upsert.js b/lib/upsert.js index dd5d65d..d3c0616 100644 --- a/lib/upsert.js +++ b/lib/upsert.js @@ -9,10 +9,51 @@ this.Upserter = (function() { /** @constructor */ + // FIXME (JamesChristie+nilmethod) document post body input function Upserter(request) { this.params = request; this.record_data = request['record_data']; this.reply_list = []; + this.exception = null; + } + + /** + * Iterates over `record_data` calling `executeUpsertRequest` on each item + * + * @method + * @memberof Upserter + * @return {null} + */ + Upserter.prototype.upsertRecords = function() { + for(index in this.record_data) { + request_data = this.record_data[index]; + this.executeUpsertRequest(request_data); + } + } + + /** + * Initializes and executes an `UpsertRequest` calling `accumulateResult()` + * + * @method + * @memberof Upserter + * @param {object} An individual item's records + * @return {null} + */ + Upserter.prototype.executeUpsertRequest = function(request_data) { + upsert_request = new UpsertRequest(request_data); + upsert_request.execute(); + this.accumulateResult(upsert_request.generateReply()); + } + + /** + * Pushes the result onto the `reply_list` array + * + * @method + * @memberof Upserter + * @return {null} + */ + Upserter.prototype.accumulateResult = function(result) { + this.reply_list.push(result); } /** @@ -22,12 +63,101 @@ this.Upserter = (function() { * @memberof Upserter * @return {object} The object containing a formatted summary of the results of the request */ - Upserter.prototype.reply = function() { + Upserter.prototype.generateReply = function() { return NetsuiteToolkit.formatReply(this.params, this.replyList); } return Upserter; })(); +/** + * UpsertRequest Class + * @class UpsertRequest + * @param {object} record_data The data from a client request + * @return {Loader} A new instance of UpsertRequest + */ +this.UpsertRequest = (function() { + + /** @constructor */ + function UpsertRequest(record_data) { + this.params = record_data; + this.record = null; + this.written_id = null; + + this.internalid = record_data['internalid'] || null; + this.record_type = record_data['record_type']; + this.literal_field_data = record_data['literal_fields']; + this.sublist_data = record_data['sublists']; + } + + /** + * Performs the UpsertRequest + * + * @method + * @memberof UpsertRequest + * @return {null} + */ + UpsertRequest.prototype.execute = function() { + this.record = this.loadOrInitializeRecord(); + NetsuiteToolkit.RecordProcessor.updateLiterals(this.record, this.literal_field_data); + this.processSublists(); + this.written_id = NetsuiteToolkit.submitRecord(this.record); + } + + /** + * Finds or creates a new record based on the presence of `internalid` + * + * @method + * @memberof UpsertRequest + * @return {null} + */ + UpsertRequest.prototype.loadOrInitializeRecord = function() { + if(this.internalid) { + this.record = NetsuiteToolkit.loadRecord(this.record_type, this.internalid); + } else { + this.record = NetsuiteToolkit.initializeRecord(this.record_type); + } + } + + /** + * Iterates through given sublists calling `executeSublistProcessor()` + * + * @method + * @memberof UpsertRequest + * @return {null} + */ + UpsertRequest.prototype.processSublists = function() { + for(index in this.sublist_data) { + sublist = this.sublist_data[index]; + this.executeSublistProcessor(sublist); + } + } + + /** + * Initializes and calls `execute()` on the `NetsuiteToolkit.SublistProcessor()` + * + * @method + * @memberof UpsertRequest + * @return {null} + */ + UpsertRequest.prototype.executeSublistProcessor = function(sublist_data) { + sublist_processor = new NetsuiteToolkit.SublistProcessor(this.record, sublist_data); + sublist_processor.execute(); + } + + /** + * Calls `NetsuiteToolkit.formatReply()` passing it `params` and `written_id` + * + * @method + * @memberof UpsertRequest + * @return {object} Formatted reply + */ + UpsertRequest.prototype.generateReply = function() { + return NetsuiteToolkit.formatReply(this.params, this.written_id); + } + + return UpsertRequest; +})(); + var postHandler = function(request) { } diff --git a/spec/load.spec.js b/spec/load.spec.js index 08c4f51..50accd1 100644 --- a/spec/load.spec.js +++ b/spec/load.spec.js @@ -58,7 +58,7 @@ describe('Loader', function() { describe('no error is thrown', function() { beforeEach(function() { - this.calls = [[this.first_param], [this.second_param], [this.third_param]]; + this.calls = [[this.first_param], [this.second_param], [this.third_param]]; spyOn(loader, 'executeLoadRequest'); loader.loadRecords(); }); @@ -239,7 +239,7 @@ describe('LoadRequest', function() { expect(this.result).toEqual(this.params_hash); }); - }) + }); describe('generateReply()', function() { diff --git a/spec/netsuite_toolkit.spec.js b/spec/netsuite_toolkit.spec.js index fa31fee..9bd15a6 100644 --- a/spec/netsuite_toolkit.spec.js +++ b/spec/netsuite_toolkit.spec.js @@ -165,6 +165,23 @@ describe("NetsuiteToolkit", function() { }); + describe('insertLineItem()', function() { + + beforeEach(function() { + this.index = 16; + this.field_name = 'somefield'; + this.record = {}; + this.record.insertLineItem = function() {} + spyOn(this.record, 'insertLineItem'); + NetsuiteToolkit.insertLineItem(this.record, this.field_name, this.index); + }); + + it('should call insertLineItem on a given record', function() { + expect(this.record.insertLineItem).toHaveBeenCalledWith(this.field_name, this.index); + }); + + }); + describe('removeLineItem()', function() { beforeEach(function() { @@ -259,4 +276,520 @@ describe("NetsuiteToolkit", function() { expect(this.formattedException['trace']).toEqual(this.exception.getStackTrace()); }); }); + + describe('RecordProcessor', function() { + + describe('updateLiterals(fieldData)', function() { + + beforeEach(function() { + this.record = {}; + this.fieldData = { + 'custfield': 'somevalue', + 'foo': 'bar' + }; + this.call_count = Object.keys(this.fieldData).length; + this.first_call = ['custfield', 'somevalue']; + this.last_call = ['foo', 'bar']; + this.args = [[this.record, 'custfield', 'somevalue'], [this.record, 'foo', 'bar']]; + spyOn(NetsuiteToolkit, 'setFieldValue'); + NetsuiteToolkit.RecordProcessor.updateLiterals(this.record, this.fieldData); + }); + + it('should call setLiteral for each element of fieldData', function() { + expect(NetsuiteToolkit.setFieldValue.callCount).toEqual(this.call_count); + }); + + // NOTE (JamesChristie+nilmethod) This test assumes order of object fields is + // enforced by nodejs. There is no gurantee that Netsuite does this. + it('should call setLiteral with the data for custfield', function() { + expect(NetsuiteToolkit.setFieldValue.argsForCall).toEqual(this.args); + }); + + }); + + }); + + describe('SublistProcessor', function() { + + beforeEach(function() { + this.record = {'stuff': 'junk'}; + this.name = 'arbitrary_sublist'; + this.indexed_create = {'index': '42', 'data': {}}; + this.unindexed_create = {'data': {}}; + this.indexed_update = {'index': '42', 'data': {}}; + this.matched_update = {'match': 'item', 'data': {}}; + this.invalid_update = {'data': {}}; + this.indexed_excise = {'index': '42', 'data': {}}; + this.matched_excise = {'match': 'item', 'data': {}}; + this.invalid_excise = {}; + + this.sublist_data = { + 'name': this.name, + 'create': [ + this.indexed_create, + this.unindexed_create + ], + 'update': [ + this.indexed_update, + this.matched_update, + this.invalid_update + ], + 'excise': [ + this.indexed_excise, + this.matched_excise, + this.invalid_excise + ] + }; + + this.processor = new NetsuiteToolkit.SublistProcessor(this.record, this.sublist_data); + }); + + describe('exceptions', function() { + + it('should define an exception for line items not matched', function() { + expect(NetsuiteToolkit.SublistProcessor.UnableToMatch instanceof Error).toEqual(true); + }); + + it('should define an exception for malformed request data', function() { + expect(NetsuiteToolkit.SublistProcessor.MalformedData instanceof Error).toEqual(true); + }); + + }); + + describe('constructor', function() { + + describe('valid data is given', function() { + + it('should populate the record', function() { + expect(this.processor.record).toEqual(this.record); + }); + + it('should populate the create_list', function() { + expect(this.processor.create_list).toEqual(this.sublist_data['create']) + }); + + it('should populate the update_list', function() { + expect(this.processor.update_list).toEqual(this.sublist_data['update']) + }); + + it('should populate the excision_list', function() { + expect(this.processor.excise_list).toEqual(this.sublist_data['excise']) + }); + + it('should populate the sublist_name' , function() { + expect(this.processor.sublist_name).toEqual(this.sublist_data['name']); + }); + + }); + + describe('no data is given', function() { + + beforeEach(function() { + this.blank_sublist_data = {}; + this.blank_processor = new NetsuiteToolkit.SublistProcessor(this.record, + this.blank_sublist_data); + }); + + it('should provide an empty create_list', function() { + expect(this.blank_processor.create_list).toEqual([]); + }); + + it('should provide an empty update_list', function() { + expect(this.blank_processor.update_list).toEqual([]); + }); + + it('should provide an empty excision_list', function() { + expect(this.blank_processor.excise_list).toEqual([]); + }); + + }); + + }); + + describe('execute()', function() { + + beforeEach(function() { + spyOn(this.processor, 'processCreations'); + spyOn(this.processor, 'processUpdates'); + spyOn(this.processor, 'processExcisions'); + this.processor.execute(); + }); + + it('should call processCreations', function() { + expect(this.processor.processCreations).toHaveBeenCalled(); + }); + + it('should call processUpdates',function() { + expect(this.processor.processUpdates).toHaveBeenCalled(); + }); + + it('should call processExcisions', function() { + expect(this.processor.processExcisions).toHaveBeenCalled(); + }); + + }); + + describe('processCreations()', function() { + beforeEach(function() { + this.calls = [[this.indexed_create], [this.unindexed_create]]; + spyOn(this.processor, 'createLineItem'); + this.processor.processCreations(); + }); + + it('should call createLineItem for each element of create_list', function() { + expect(this.processor.createLineItem.argsForCall).toEqual(this.calls); + }); + }); + + describe('processUpdates()', function() { + + beforeEach(function() { + this.calls = [[this.indexed_update], [this.matched_update], [this.invalid_update]]; + spyOn(this.processor, 'updateLineItem'); + this.processor.processUpdates(); + }); + + it('should call updateLineItem for each element of update_list', function() { + expect(this.processor.updateLineItem.argsForCall).toEqual(this.calls); + }); + + }); + + describe('processExcisions()', function() { + + beforeEach(function() { + this.calls = [[this.indexed_excise], [this.matched_excise], [this.invalid_excise]]; + spyOn(this.processor, 'exciseLineItem'); + this.processor.processExcisions(); + }); + + it('should call exciseLineItem for each element of excise_list', function() { + expect(this.processor.exciseLineItem.argsForCall).toEqual(this.calls); + }); + + }); + + describe('createLineItem()', function() { + + beforeEach(function() { + spyOn(NetsuiteToolkit, 'insertLineItem'); + spyOn(this.processor, 'updateLineItemFields'); + }); + + describe('an index is given', function() { + + beforeEach(function() { + this.index = this.indexed_create['index']; + this.data = this.indexed_create['data']; + this.processor.createLineItem(this.indexed_create); + }); + + it('should call insertLineItem with the given index', function() { + expect(NetsuiteToolkit.insertLineItem).toHaveBeenCalledWith(this.record, this.name, + this.index); + }); + + it('should call updateLineItemFields with the name, index, and data', function() { + expect(this.processor.updateLineItemFields).toHaveBeenCalledWith(this.index, this.data); + }); + + }); + + describe('no index is given', function() { + + beforeEach(function() { + this.index = 14; + this.data = this.unindexed_create['data']; + spyOn(NetsuiteToolkit, 'getLineItemCount').andReturn(this.index); + this.processor.createLineItem(this.unindexed_create); + }) + + it('should call getLineItemCount with sublist_name', function() { + expect(NetsuiteToolkit.getLineItemCount).toHaveBeenCalledWith(this.record, this.name); + }); + + it('should call insertLineItem with the returned index', function() { + expect(NetsuiteToolkit.insertLineItem).toHaveBeenCalledWith(this.record, this.name, + this.index); + }); + + it('should call updateLineItemFields with the name, index, and data', function() { + expect(this.processor.updateLineItemFields).toHaveBeenCalledWith(this.index, this.data); + }); + + }); + + }); + + describe('updateLineItem()', function() { + + beforeEach(function() { + this.index = 42; + this.data = {'foo': 'bar'}; + this.match = 'matchdata'; + spyOn(this.processor, 'updateLineItemFields'); + }); + + describe('an index is given', function() { + + beforeEach(function() { + this.update_request = {'index': this.index, 'data': this.data}; + this.processor.updateLineItem(this.update_request); + }); + + it('should call updateLineItemFields with a given index and data', function() { + expect(this.processor.updateLineItemFields).toHaveBeenCalledWith(this.index, this.data); + }); + + }); + + describe('a match field is given', function() { + + beforeEach(function() { + this.found_index = 24; + spyOn(this.processor, 'matchLineItemByField').andReturn(this.found_index); + this.found_update_request = {'data': this.data, 'match': this.match}; + this.processor.updateLineItem(this.found_update_request); + }); + + it('should call matchLineItemByField with a given match field and data', function() { + expect(this.processor.matchLineItemByField).toHaveBeenCalledWith(this.match, this.data); + }); + + it('should call updateLineItemFields with a given index and data', function() { + expect(this.processor.updateLineItemFields).toHaveBeenCalledWith(this.found_index, + this.data); + }); + + }); + + describe('both an index and match field are given', function() { + + beforeEach(function() { + this.match_index_request = { + 'index': this.index, + 'match': this.match, + 'data': this.data + }; + + spyOn(this.processor, 'matchLineItemByField'); + this.processor.updateLineItem(this.match_index_request); + }); + + it('should not call matchLineItemByField', function() { + expect(this.processor.matchLineItemByField).not.toHaveBeenCalled(); + }); + + it('should call updateLineItemFields with a given index and data', function() { + expect(this.processor.updateLineItemFields).toHaveBeenCalledWith(this.index, this.data); + }); + + }); + + describe('neither an index or match field are given', function() { + + beforeEach(function() { + this.broken_request = {'foo': 'bar'} + this.update_call = function() { + this.processor.updateLineItem(this.broken_request); + }.bind(this); + }); + + it('should throw NetsuiteToolkit.SublistProcessor.UnableToMatch', function() { + expect(this.update_call).toThrow(NetsuiteToolkit.SublistProcessor.UnableToMatch); + }); + + }); + + }); + + describe('exciseLineItem()', function() { + + beforeEach(function() { + this.index = 42; + this.data = {'foo': 'bar'}; + this.match = 'matchdata'; + spyOn(NetsuiteToolkit, 'removeLineItem'); + }); + + describe('an index is given', function() { + + beforeEach(function() { + this.excise_request = {'index': this.index, 'data': this.data}; + this.processor.exciseLineItem(this.excise_request); + }); + + it('should call removeLineItem with a given index and data', function() { + expect(NetsuiteToolkit.removeLineItem).toHaveBeenCalledWith(this.processor.record, + this.processor.sublist_name, + this.index); + }); + + }); + + describe('a match field is given', function() { + + beforeEach(function() { + this.found_index = 24; + spyOn(this.processor, 'matchLineItemByField').andReturn(this.found_index); + this.found_excise_request = {'data': this.data, 'match': this.match}; + this.processor.exciseLineItem(this.found_excise_request); + }); + + it('should call matchLineItemByField with a given match field and data', function() { + expect(this.processor.matchLineItemByField).toHaveBeenCalledWith(this.match, this.data); + }); + + it('should call removeLineItem with a given index and data', function() { + expect(NetsuiteToolkit.removeLineItem).toHaveBeenCalledWith(this.processor.record, + this.processor.sublist_name, + this.found_index); + }); + + }); + + describe('both an index and match field are given', function() { + + beforeEach(function() { + this.match_index_request = { + 'index': this.index, + 'match': this.match, + 'data': this.data + }; + + spyOn(this.processor, 'matchLineItemByField'); + this.processor.exciseLineItem(this.match_index_request); + }); + + it('should not call matchLineItemByField', function() { + expect(this.processor.matchLineItemByField).not.toHaveBeenCalled(); + }); + + it('should call removeLineItem with a given index and data', function() { + expect(NetsuiteToolkit.removeLineItem).toHaveBeenCalledWith(this.processor.record, + this.processor.sublist_name, + this.index); + }); + + }); + + describe('neither an index or match field are given', function() { + + beforeEach(function() { + this.broken_request = {'foo': 'bar'} + this.update_call = function() { + this.processor.exciseLineItem(this.broken_request); + }.bind(this); + }); + + it('should throw NetsuiteToolkit.SublistProcessor.UnableToMatch', function() { + expect(this.update_call).toThrow(NetsuiteToolkit.SublistProcessor.UnableToMatch); + }); + + }); + + }); + + describe('updateLineItemFields()', function() { + + beforeEach(function() { + this.index = 7; + this.data = { + 'field1': 'value1', + 'field2': 'value2' + }; + this.calls = [ + [this.record, this.name, this.index, 'field1', 'value1'], + [this.record, this.name, this.index, 'field2', 'value2'] + ]; + spyOn(NetsuiteToolkit, 'setLineItemValue'); + this.processor.updateLineItemFields(this.index, this.data); + }); + + it('should call NetsuiteToolkit.setLineItemValue for each element of the data', function() { + expect(NetsuiteToolkit.setLineItemValue.argsForCall).toEqual(this.calls); + }); + + }); + + describe('matchLineItemByField()', function() { + + beforeEach(function() { + this.match_field = 'jedi'; + this.data = {'jedi': 'Yoda'}; + spyOn(NetsuiteToolkit, 'getLineItemCount').andReturn(16); + }); + + describe('when the field data is matched', function() { + + beforeEach(function() { + this.index = 1; + spyOn(this.processor, 'compareLineItemValue').andReturn(true); + this.result = this.processor.matchLineItemByField(this.match_field, this.data); + }); + + it('should return the index based on the field matched', function() { + expect(this.result).toEqual(this.index); + }); + + }); + + describe('when the field data is not matched', function() { + + beforeEach(function() { + this.call = function() { + this.processor.matchLineItemByField(this.match_field, this.data); + }.bind(this); + spyOn(this.processor, 'compareLineItemValue').andReturn(false); + }); + + it('should throw NetsuiteToolkit.SublistProcessor.UnableToMatch error', function() { + expect(this.call).toThrow(NetsuiteToolkit.SublistProcessor.UnableToMatch); + }); + + }); + }); + + describe('compareLineItemValue()', function() { + + beforeEach(function() { + this.index = 1; + this.match_field = 'planet'; + this.match_value = 'venus'; + }); + + describe('when the field has a matching value', function() { + + beforeEach(function() { + spyOn(NetsuiteToolkit, 'getLineItemValue').andReturn(this.match_value); + this.result = this.processor.compareLineItemValue(this.index, this.match_field, + this.match_value); + }); + + it('returns a true value', function() { + expect(this.result).toEqual(true); + }); + + }); + + + describe('when the field does not have a matching value', function() { + + beforeEach(function() { + this.non_matching_value = 'not venus'; + spyOn(NetsuiteToolkit, 'getLineItemValue').andReturn(this.non_matching_value); + this.result = this.processor.compareLineItemValue(this.index, this.match_field, + this.match_value); + }); + + it('returns a false value', function() { + expect(this.result).toEqual(false); + }); + + }); + + }); + + }); + }); diff --git a/spec/spec_helper.js b/spec/spec_helper.js index 7d52d0a..65c53d5 100644 --- a/spec/spec_helper.js +++ b/spec/spec_helper.js @@ -6,4 +6,5 @@ SavedSearch = require('../lib/saved_search.js').SavedSearch; Searcher = require('../lib/search.js').Searcher; Deleter = require('../lib/delete.js').Deleter; Upserter = require('../lib/upsert.js').Upserter; +UpsertRequest = require('../lib/upsert.js').UpsertRequest; Transformer = require('../lib/transform.js').Transformer; diff --git a/spec/upsert.spec.js b/spec/upsert.spec.js index 40a3f30..9793ca6 100644 --- a/spec/upsert.spec.js +++ b/spec/upsert.spec.js @@ -3,9 +3,15 @@ require('./spec_helper.js'); describe('Upserter', function() { var upserter; - var record_data = {}; + var record_with_sublists = { + }; + var record_without_sublists = { + }; + var record_data = [ + record_without_sublists, + record_with_sublists + ]; var request = { - 'record_type': 'salesorder', 'record_data': record_data }; @@ -18,33 +24,97 @@ describe('Upserter', function() { // constructor describe('Upserter(request)', function() { - beforeEach(function() { - this.new_upserter = new Upserter(request); - }); - it('should set the params', function() { - expect(this.new_upserter.params).toEqual(request); + expect(upserter.params).toEqual(request); }); it('should set the record_data', function() { - expect(this.new_upserter.record_data).toEqual(request['record_data']); + expect(upserter.record_data).toEqual(request['record_data']); }); it('should initialize the reply_list as an empty Array', function() { - expect(this.new_upserter.reply_list).toEqual([]); + expect(upserter.reply_list).toEqual([]); + }); + + it('should initialize the exception to null', function() { + expect(upserter.exception).toEqual(null); }); }); - describe('reply', function() { + describe('upsertRecords()', function() { + + beforeEach(function() { + this.upsert_one = {'upsert': 'one'}; + this.upsert_two = {'upsert': 'two'}; + upserter.record_data = [this.upsert_one, this.upsert_two]; + this.calls = [[this.upsert_one], [this.upsert_two]]; + spyOn(upserter, 'executeUpsertRequest'); + upserter.upsertRecords(); + }); + + it('should call executeUpsertRequest for each element of record_data', function() { + expect(upserter.executeUpsertRequest.argsForCall).toEqual(this.calls); + }); + + }); + + describe('executeUpsertRequest()', function() { + + beforeEach(function() { + this.request_data = {'request': 'stuff'}; + this.reply = {'it': 'worked'}; + this.upsert_request = {}; + this.upsert_request.execute = function() {} + this.upsert_request.generateReply = function() {} + spyOn(global, 'UpsertRequest').andReturn(this.upsert_request); + spyOn(this.upsert_request, 'execute'); + spyOn(this.upsert_request, 'generateReply').andReturn(this.reply); + spyOn(upserter, 'accumulateResult'); + upserter.executeUpsertRequest(this.request_data); + }); + + it('should call the constructor on UpsertRequest', function() { + expect(global.UpsertRequest).toHaveBeenCalledWith(this.request_data); + }); + + it('should call execute on the newly created instance of UpsertRequest', function() { + expect(this.upsert_request.execute).toHaveBeenCalled(); + }); + + it('should call generateReply on the UpsertRequest instance', function() { + expect(this.upsert_request.generateReply).toHaveBeenCalled(); + }); + + it('should call accumulateResult with the results of generateReply', function() { + expect(upserter.accumulateResult).toHaveBeenCalledWith(this.reply); + }); + + }); + + describe('accumulateResult()', function() { + + beforeEach(function() { + this.formatted_reply = {'reply': 'body'}; + spyOn(upserter.reply_list, 'push'); + upserter.accumulateResult(this.formatted_reply); + }); + + it('should call concat on reply_list', function() { + expect(upserter.reply_list.push).toHaveBeenCalledWith(this.formatted_reply); + }); + + }); + + describe('generateReply()', function() { beforeEach(function() { this.fake_reply = {}; spyOn(NetsuiteToolkit, 'formatReply').andReturn(this.fake_reply); - this.result = upserter.reply(); + this.result = upserter.generateReply(); }); - it('should call formatReply on CommonObject', function() { + it('should call formatReply on NetsuiteToolkit', function() { expect(NetsuiteToolkit.formatReply).toHaveBeenCalledWith(upserter.params, upserter.replyList); }); @@ -53,4 +123,208 @@ describe('Upserter', function() { }); }); + +}); + +describe('UpsertRequest', function() { + + var upsert_request; + var internalid = '123456789'; + var record_type = 'salesorder'; + var literal_fields = { + 'email': 'name@domain.suffix', + 'total': '19.99' + }; + var sublist_one = { 'stuff': 'junk' }; + var sublist_two = { 'thing': 'sundries' }; + var sublists = [ + sublist_one, + sublist_two + ]; + var record_data = { + 'record_type': record_type, + 'literal_fields': literal_fields, + 'sublists': sublists + }; + var record_data_with_id = { + 'internalid': internalid, + 'record_type': record_type, + 'literal_fields': literal_fields, + 'sublists': sublists + }; + + beforeEach(function() { + upsert_request = new UpsertRequest(record_data); + }); + + describe('constructor()', function() { + + it('should populate the params with the record_data', function() { + expect(upsert_request.params).toEqual(record_data); + }); + + it('record_id should not have a value', function() { + expect(upsert_request.internalid).toEqual(null); + }); + + it('should populate the record_type', function() { + expect(upsert_request.record_type).toEqual(record_type); + }); + + it('should populate the literal_field_data', function() { + expect(upsert_request.literal_field_data).toEqual(literal_fields); + }); + + it('should populate the sublist_data', function() { + expect(upsert_request.sublist_data).toEqual(sublists); + }); + + it('should initialize record to null', function() { + expect(upsert_request.record).toEqual(null); + }); + + it('should initialize written_id to null', function() { + expect(upsert_request.written_id).toEqual(null); + }); + + describe('an id is present', function() { + + beforeEach(function() { + this.upsert_request_with_id = new UpsertRequest(record_data_with_id); + }); + + it('internalid should have a value', function() { + expect(this.upsert_request_with_id.internalid).toEqual(internalid); + }); + + }); + + }); + + describe('execute()', function() { + + beforeEach(function() { + this.new_id = 17; + this.record = {'this is': 'a record'}; + spyOn(upsert_request, 'loadOrInitializeRecord').andReturn(this.record); + spyOn(NetsuiteToolkit.RecordProcessor, 'updateLiterals'); + spyOn(upsert_request, 'processSublists'); + spyOn(NetsuiteToolkit, 'submitRecord').andReturn(this.new_id); + upsert_request.execute(); + }); + + it('should call loadOrInitializeRecord', function() { + expect(upsert_request.loadOrInitializeRecord).toHaveBeenCalled(); + }); + + it('should call NetsuiteToolkit.RecordProcessor.updateLiterals', function() { + expect(NetsuiteToolkit.RecordProcessor.updateLiterals).toHaveBeenCalledWith( + upsert_request.record, + upsert_request.literal_field_data + ); + }); + + it('should call processSublists', function() { + expect(upsert_request.processSublists).toHaveBeenCalled(); + }); + + it('should call NetsuiteToolkit.submitRecord with the now mutated record', function() { + expect(NetsuiteToolkit.submitRecord).toHaveBeenCalledWith(upsert_request.record); + }); + + it('should set written_id to the return value of NetsuiteToolkit.submitRecord', function() { + expect(upsert_request.written_id).toEqual(this.new_id); + }); + + }); + + describe('loadOrInitializeRecord()', function() { + + describe('an internalid is present', function() { + + beforeEach(function() { + upsert_request.internalid = internalid; + spyOn(NetsuiteToolkit, 'loadRecord'); + upsert_request.loadOrInitializeRecord(); + }); + + it('should call NetsuiteToolkit.loadRecord', function() { + expect(NetsuiteToolkit.loadRecord).toHaveBeenCalledWith(upsert_request.record_type, + upsert_request.internalid); + }); + + }); + + describe('an internalid is not present', function() { + + beforeEach(function() { + spyOn(NetsuiteToolkit, 'initializeRecord'); + upsert_request.loadOrInitializeRecord(); + }); + + it('should call NetsuiteToolkit.initializeRecord', function() { + expect(NetsuiteToolkit.initializeRecord).toHaveBeenCalledWith(upsert_request.record_type); + }); + + }); + + }); + + describe('processSublists()', function() { + + beforeEach(function() { + this.calls = [ + [sublist_one], + [sublist_two] + ]; + spyOn(upsert_request, 'executeSublistProcessor'); + upsert_request.processSublists(); + }); + + it('should call executeSublistProcessor for each element of sublist_data', function() { + expect(upsert_request.executeSublistProcessor.argsForCall).toEqual(this.calls); + }); + + }); + + describe('executeSublistProcessor()', function() { + + beforeEach(function() { + this.fake_processor = {}; + this.fake_processor.execute = function() {} + spyOn(NetsuiteToolkit, 'SublistProcessor').andReturn(this.fake_processor); + spyOn(this.fake_processor, 'execute'); + upsert_request.executeSublistProcessor(sublist_one); + }); + + it('should call the constructor of NetsuiteToolkit.SublistProcessor', function() { + expect(NetsuiteToolkit.SublistProcessor).toHaveBeenCalledWith(upsert_request.record, + sublist_one); + }); + + it('should call execute on the newly initialized SublistProcessor instance', function() { + expect(this.fake_processor.execute).toHaveBeenCalled(); + }); + + }); + + describe('generateReply()', function() { + + beforeEach(function() { + this.fake_reply = {}; + spyOn(NetsuiteToolkit, 'formatReply').andReturn(this.fake_reply); + this.result = upsert_request.generateReply(); + }); + + it('should call formatReply on NetsuiteToolkit', function() { + expect(NetsuiteToolkit.formatReply).toHaveBeenCalledWith(upsert_request.params, + upsert_request.written_id); + }); + + it('should return the output of formatreply', function() { + expect(this.result).toEqual(this.fake_reply); + }); + + }); + });