nlapiCopyRecord ( type , id , initializeValues )
/**
* 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
*/
nlapiLoadRecord ( 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
*/
nlapiCreateRecord ( type , 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
*/
nlapiSubmitRecord ( record , doSourcing , ignoreMandatoryFields )
/**
* 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
*/
nlapiDeleteRecord ( type , id )
/**
* 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
*/
nlapiSearchRecord ( type , id , filters , columns )
/**
* 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
*/
nlapiSearchGlobal ( keywords )
/**
* 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
*/
nlapiSearchDuplicate ( type , fields , id )
/**
* 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
*/
nlapiTransformRecord ( type , id , transformType , transformValues )
/**
* 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
*/
nlapiLookupField ( type , id , fields , text )
/**
* 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
*/
nlapiSubmitField ( type , id , fields , values , doSourcing )
/**
* 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
*/
nlapiAttachRecord ( type1 , id1 , type2 , id2 , properties )
/**
* 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
*/
nlapiDetachRecord ( 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
*/
nlapiResolveURL ( type , subtype , id , pagemode )
/**
* 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
*/
nlapiSetRedirectURL ( type , subtype , id , pagemode , parameters )
/**
* 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
*/
nlapiRequestURL ( url , postdata , headers , callback , method )
/**
* 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
*/
nlapiGetContext ( )
/**
* Return context information about the current user/script.
*
* @return {nlobjContext}
*
* @since 2007.0
*/
nlapiGetUser ( )
/**
* 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
*/
nlapiGetRole ( )
/**
* 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
*/
nlapiGetDepartment ( )
/**
* Return the internal ID for the current user's department.
*
* @return {int}
*
* @since 2005.0
*/
nlapiGetLocation ( )
/**
* Return the internal ID for the current user's location.
*
* @return {int}
*
* @since 2005.0
*/
nlapiGetSubsidiary ( )
/**
* Return the internal ID for the current user's subsidiary.
*
* @return {int}
*
* @since 2008.1
*/
nlapiGetRecordType ( )
/**
* Return the recordtype corresponding to the current page or userevent script.
*
* @return {string}
*
* @since 2007.0
*/
nlapiGetRecordId ( )
/**
* Return the internal ID corresponding to the current page or userevent script.
*
* @return {int}
*
* @since 2007.0
*/
nlapiSendEmail ( from , to , subject , body , cc , bcc , records , files )
/**
* 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
*/
nlapiSendCampaignEmail ( campaigneventid , recipientid )
/**
* 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
*/
nlapiSendFax ( from , to , subject , body , records , files )
/**
* 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
*/
nlapiGetField ( fldnam )
/**
* Return field definition for a field.
*
* @param {string} fldnam the name of the field
* @return {nlobjField}
*
* @since 2009.1
*/
nlapiGetMatrixField ( type , fldnam , column )
/**
* 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
*/
nlapiGetLineItemField ( type , fldnam , linenum )
/**
* 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
*/
nlapiGetLineItemMatrixField ( type , fldnam , linenum , column )
/**
* 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
*/
nlapiGetFieldValue ( fldnam )
/**
* 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
*/
nlapiSetFieldValue ( fldnam , value , firefieldchanged , synchronous )
/**
* 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
*/
nlapiGetFieldText ( fldnam )
/**
* 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
*/
nlapiSetFieldText ( fldnam , txt , firefieldchanged , synchronous )
/**
* 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
*/
nlapiGetFieldValues ( fldnam )
/**
* 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
*/
nlapiSetFieldValues ( fldnam , values , firefieldchanged , synchronous )
/**
* 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
*/
nlapiGetFieldTexts ( fldnam )
/**
* 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
*/
nlapiSetFieldTexts ( fldnam , texts , firefieldchanged , synchronous )
/**
* 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
*/
nlapiGetMatrixValue ( type , fldnam , column )
/**
* 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
*/
nlapiSetMatrixValue ( type , fldnam , column , value , firefieldchanged , synchronous )
/**
* 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
*/
nlapiGetCurrentLineItemMatrixValue ( type , fldnam , column )
/**
* 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
*/
nlapiSetCurrentLineItemMatrixValue ( type , fldnam , column , value , firefieldchanged , synchronous )
/**
* 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
*/
nlapiGetLineItemMatrixValue ( type , fldnam , linenum , column )
/**
* 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
*/
nlapiGetLineItemValue ( type , fldnam , linenum )
/**
* 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
*/
nlapiSetLineItemValue ( type , fldnam , linenum , value )
/**
* 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
*/
nlapiGetLineItemText ( type , fldnam , linenum )
/**
* 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
*/
nlapiFindLineItemValue ( type , fldnam , val )
/**
* 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
*/
nlapiFindLineItemMatrixValue ( type , fldnam , column , 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
*/
nlapiGetMatrixCount ( type , fldnam )
/**
* 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
*/
nlapiGetLineItemCount ( type )
/**
* 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
*/
nlapiInsertLineItem ( type , line )
/**
* 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
*/
nlapiRemoveLineItem ( 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
*/
nlapiSetCurrentLineItemValue ( type , fldnam , value , firefieldchanged , synchronous )
/**
* 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
*/
nlapiSetCurrentLineItemText ( type , fldnam , txt , 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
*/
nlapiGetCurrentLineItemValue ( type , fldnam )
/**
* 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
*/
nlapiGetCurrentLineItemText ( 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
*/
nlapiGetCurrentLineItemIndex ( type )
/**
* Return the line number for the currently selected line.
*
* @param {string} type sublist name
* @return {int}
*
* @since 2005.0
*/
nlapiSetLineItemDisabled ( type , fldnam , disable , linenum )
/**
* 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
*/
nlapiGetFieldMandatory ( fldnam )
/**
* Return field mandatoriness.
*
* @param {string} fldnam field name
* @return {boolean}
*
* @since 2009.1
*/
nlapiGetLineItemMandatory ( type , 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
*/
nlapiSetFieldMandatory ( fldnam , mandatory )
/**
* Make a field mandatory.
*
* @param {string} fldnam field name
* @param {boolean} mandatory if true then field is made mandatory
* @return {void}
*
* @since 2009.1
*/
nlapiSetLineItemMandatory ( type , 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
*/
nlapiSelectLineItem ( type , linenum )
/**
* Select an existing line in a sublist.
*
* @param {string} type sublist name
* @param {int} linenum line number to select
* @return {void}
*
* @since 2005.0
*/
nlapiCommitLineItem ( type )
/**
* Save changes made on the currently selected line to the sublist.
*
* @param {string} type sublist name
* @return {void}
*
* @since 2005.0
*/
nlapiCancelLineItem ( 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
*/
nlapiSelectNewLineItem ( 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
*/
nlapiRefreshLineItems ( 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
*/
nlapiInsertSelectOption ( fldnam , value , text , selected )
/**
* 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
*/
nlapiRemoveSelectOption ( fldnam , value )
/**
* 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
*/
nlapiInsertLineItemOption ( type , fldnam , value , text , selected )
/**
* 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
*/
nlapiRemoveLineItemOption ( type , fldnam , value )
/**
* 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
*/
nlapiIsLineItemChanged ( type )
/**
* 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
*/
nlapiGetNewRecord ( )
/**
* 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
*/
nlapiGetOldRecord ( )
/**
* 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
*/
nlapiCreateError ( code , details , suppressEmail )
/**
* 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
*/
nlapiCreateForm ( title , hideHeader )
/**
* 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
*/
nlapiCreateList ( 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
*/
nlapiCreateAssistant ( 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
*/
nlapiLoadFile ( id )
/**
* 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
*/
nlapiSubmitFile ( file )
/**
* 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
*/
nlapiDeleteFile ( id )
/**
* 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
*/
nlapiCreateFile ( name , type , contents )
/**
* 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
*/
nlapiMergeRecord ( id , baseType , baseId , altType , altId , fields )
/**
* 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
*/
nlapiPrintRecord ( type , id , format , properties )
/**
* 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
*/
nlapiXMLToPDF ( input )
/**
* 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
*/
nlapiLogExecution ( type , title , details )
/**
* 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
*/
nlapiScheduleScript ( script , deployment , parameters )
/**
* 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
*/
nlapiOutboundSSO ( ssoAppKey )
/**
* Return a URL with a generated OAuth token.
* @restriction Suitelets and Portlets only
* @governance 20 units
*
* @param {string} ssoAppKey
* @return {string}
*
* @since 2009.2
*/
nlapiLoadConfiguration ( type )
/**
* Loads a configuration record
* @restriction Server SuiteScript only
* @governance 10 units
*
* @param {string} type
* @return {nlobjConfiguration}
*
* @since 2009.2
*/
nlapiSubmitConfiguration ( setup )
/**
* Commits all changes to a configuration record.
* @restriction Server SuiteScript only
* @governance 10 units
*
* @param {nlobjConfiguration} setup record
* @return (void)
*
* @since 2009.2
*/
nlapiStringToDate ( str , format )
/**
* 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
*/
nlapiDateToString ( d , formattype )
/**
* 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
*/
nlapiAddDays ( d , days )
/**
* 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
*/
nlapiAddMonths ( d , months )
/**
* 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
*/
nlapiFormatCurrency ( str )
/**
* 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
*/
nlapiEncrypt ( s )
/**
* Encrypt a String using a SHA-1 hash function
*
* @param {string} s string to encrypt
* @return {string}
*
* @since 2009.2
*/
nlapiEscapeXML ( text )
/**
* Escape a String for use in an XML document.
*
* @param {string} text string to escape
* @return {string}
*
* @since 2008.1
*/
nlapiStringToXML ( str )
/**
* 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
*/
nlapiXMLToString ( xml )
/**
* 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
*/
nlapiSelectValue ( node , xpath )
/**
* 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
*/
nlapiSelectValues ( 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
*/
nlapiSelectNode ( 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
*/
nlapiSelectNodes ( 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
*/
nlapiExchangeRate ( fromCurrency , toCurrency , date )
/**
* 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
*/
nlapiInitiateWorkflow ( recordtype , id , workflowid )
/**
* 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
*/
nlapiTriggerWorkflow ( recordtype , id , workflowid , actionid )
/**
* 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
*/
nlapiCreateCurrentLineSubrecord ( type , fldnam )
/**
* 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
*/
nlapiEditCurrentLineItemSubrecord ( 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
*/
nlapiRemoveCurrentLineItemSubrecord ( 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
*/
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
*/
nlapiViewLineItemSubrecord ( type , fldnam , linenum )
/**
* 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
*/
createSubrecord ( fldnam )
/**
* 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
*/
editSubrecord ( 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
*/
removeSubrecord ( 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
*/
viewSubrecord ( 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
*/
nlobjSubrecord.commit ( )
/**
* Commit the subrecord after you finish modifying it.
*
* @return {void}
*
* @method
* @memberOf nlobjSubrecord
*
* @since 2008.1
*/
nlobjSubrecord.cancel ( )
/**
* Cancel the any modification on subrecord.
*
* @return {void}
*
* @method
* @memberOf nlobjSubrecord
*
* @since 2008.1
*/
nlobjRecord ( )
/**
* 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
*/
nlobjRecord.getId ( )
/**
* 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.getRecordType ( )
/**
* 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.getField ( fldnam )
/**
* Return field metadata for field.
*
* @param {string} fldnam field name
* @return {nlobjField}
*
* @method
* @memberOf nlobjRecord
*
* @since 2009.1
*/
nlobjRecord.getSubList ( type )
/**
* Return sublist metadata for sublist.
*
* @param {string} type sublist name
* @return {nlobjSubList}
*
* @method
* @memberOf nlobjRecord
*
* @since 2009.2
*/
nlobjRecord.getMatrixField ( type , fldnam , column )
/**
* 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.getLineItemField ( type , fldnam , linenum )
/**
* 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.getLineItemMatrixField ( type , fldnam , linenum , column )
/**
* 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.setFieldValue ( name , value )
/**
* 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.setFieldValues ( name , values )
/**
* 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.getFieldValue ( name )
/**
* Return the value of a field.
*
* @param {string} name field name
* @return {string}
*
* @method
* @memberOf nlobjRecord
*
* @since 2008.1
*/
nlobjRecord.getFieldValues ( 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.setFieldText ( name , text )
/**
* 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.setFieldTexts ( name , texts )
/**
* 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.getFieldText ( name )
/**
* 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.getFieldTexts ( 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.getMatrixValue ( type , name , column )
/**
* 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.setMatrixValue ( type , name , column , value )
/**
* 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.getAllFields ( )
/**
* Return an Array of all field names on the record.
*
* @return {string[]}
*
* @method
* @memberOf nlobjRecord
*
* @since 2008.1
*/
nlobjRecord.getAllLineItemFields ( group )
/**
* 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.setLineItemValue ( group , name , line , value )
/**
* 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.getLineItemValue ( group , name , line )
/**
* 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.getLineItemText ( 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.setCurrentLineItemValue ( group , name , value )
/**
* 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.getCurrentLineItemValue ( group , name )
/**
* 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.getCurrentLineItemText ( 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.setCurrentLineItemMatrixValue ( group , name , column , value )
/**
* 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.getCurrentLineItemMatrixValue ( group , name , column )
/**
* 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.getMatrixCount ( group , name )
/**
* 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.getLineItemCount ( group )
/**
* Return the number of lines in a sublist.
*
* @param {string} group sublist name
*
* @method
* @memberOf nlobjRecord
*
* @since 2009.2
*/
nlobjRecord.findLineItemValue ( 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 {string} value sublist field value
* @return {int}
*
* @method
* @memberOf nlobjRecord
*
* @since 2009.2
*/
nlobjRecord.findLineItemMatrixValue ( group , fldnam , column , 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.insertLineItem ( group , line )
/**
* 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.removeLineItem ( 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.selectNewLineItem ( group )
/**
* Insert and select a new line in a sublist.
*
* @param {string} group sublist name
* @return {void}
*
* @method
* @memberOf nlobjRecord
*
* @since 2009.2
*/
nlobjRecord.selectLineItem ( group , line )
/**
* 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.commitLineItem ( group )
/**
* Commit the current line in a sublist.
*
* @param {string} group sublist name
* @return {void}
*
* @method
* @memberOf nlobjRecord
*
* @since 2009.2
*/
nlobjConfiguration ( )
/**
* Return a new instance of nlobjConfiguration..
*
* @classDescription Class definition for interacting with setup/configuration pages
* @return {nlobjConfiguration}
* @constructor
*
* @since 2009.2
*/
nlobjConfiguration.getType ( )
/**
* return the type corresponding to this setup record.
*
* @return {string}
*
* @method
* @memberOf nlobjConfiguration
*
* @since 2009.2
*/
nlobjConfiguration.getField ( fldnam )
/**
* return field metadata for field.
*
* @param {string} fldnam field name
* @return {nlobjField}
*
* @method
* @memberOf nlobjConfiguration
*
* @since 2009.2
*/
nlobjConfiguration.setFieldValue ( name , value )
/**
* 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.setFieldValues ( 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.getFieldValue ( name )
/**
* return the value of a field.
*
* @param {string} name field name
* @return {string}
*
* @method
* @memberOf nlobjConfiguration
*
* @since 2009.2
*/
nlobjConfiguration.getFieldValues ( 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.setFieldText ( name , text )
/**
* 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.setFieldTexts ( name , texts )
/**
* 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.getFieldText ( name )
/**
* 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.getFieldTexts ( 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.getAllFields ( )
/**
* return an Array of all field names on the record.
* @return {string[]}
*
* @method
* @memberOf nlobjConfiguration
*
* @since 2009.2
*/
nlobjFile ( )
/**
* 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
*/
nlobjFile.getName ( )
/**
* Return the name of the file.
* @return {string}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.setName ( name )
/**
* Sets the name of a file.
* @param {string} name the name of the file
* @return {void}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.getFolder ( )
/**
* return the internal ID of the folder that this file is in.
* @return {int}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.setFolder ( folder )
/**
* sets the internal ID of the folder that this file is in.
* @param {int} folder
* @return {void}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.setEncoding ( encoding )
/**
* sets the character encoding for the file.
* @param {String} encoding
* @return {void}
*
* @method
* @memberOf nlobjFile
*
* @since 2010.2
*/
nlobjFile.isOnline ( )
/**
* return true if the file is "Available without Login".
* @return {boolean}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.setIsOnline ( online )
/**
* sets the file's "Available without Login" status.
* @param {boolean} online
* @return {void}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.isInactive ( )
/**
* return true if the file is inactive.
* @return {boolean}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.setIsInactive ( inactive )
/**
* sets the file's inactive status.
* @param {boolean} inactive
* @return {void}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.getDescription ( )
/**
* return the file description.
* @return {string}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.setDescription ( descr )
/**
* sets the file's description.
* @param {string} descr the file description
* @return {void}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.getId ( )
/**
* Return the id of the file (if stored in the FC).
* @return {int}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.getSize ( )
/**
* Return the size of the file in bytes.
* @return {int}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.getURL ( )
/**
* Return the URL of the file (if stored in the FC).
* @return {string}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.getType ( )
/**
* Return the type of the file.
* @return {string}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjFile.getValue ( )
/**
* Return the value (base64 encoded for binary types) of the file.
* @return {string}
*
* @method
* @memberOf nlobjFile
*
* @since 2009.1
*/
nlobjSearchFilter ( name , join , operator , value , value2 )
/**
* 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
*/
nlobjSearchFilter.getName ( )
/**
* Return the name of this search filter.
* @return {string}
*
* @method
* @memberOf nlobjSearchFilter
*
* @since 2007.0
*/
nlobjSearchFilter.getJoin ( )
/**
* Return the join id for this search filter.
* @return {string}
*
* @method
* @memberOf nlobjSearchFilter
*
* @since 2008.1
*/
nlobjSearchFilter.getOperator ( )
/**
* Return the filter operator used.
* @return {string}
*
* @method
* @memberOf nlobjSearchFilter
*
* @since 2008.2
*/
nlobjSearchColumn ( name , join , summary )
/**
* 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
*/
nlobjSearchColumn.getName ( )
/**
* return the name of this search column.
* @return {string}
*
* @method
* @memberOf nlobjSearchColumn
* @since 2008.1
*/
nlobjSearchColumn.getJoin ( )
/**
* return the join id for this search column.
* @return {string}
*
* @method
* @memberOf nlobjSearchColumn
* @since 2008.1
*/
nlobjSearchColumn.getLabel ( )
/**
* return the label of this search column.
* @return {string}
*
* @method
* @memberOf nlobjSearchColumn
*
* @since 2009.1
*/
nlobjSearchColumn.getSummary ( )
/**
* return the summary type (avg,group,sum,count) of this search column.
* @return {string}
*
* @method
* @memberOf nlobjSearchColumn
* @since 2008.1
*/
nlobjSearchColumn.getFormula ( )
/**
* return formula for this search column.
* @return {string}
*
* @method
* @memberOf nlobjSearchColumn
*
* @since 2009.2
*/
nlobjSearchColumn.setSort ( order )
/**
* 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
*/
nlobjSearchResult ( )
/**
* 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
*/
nlobjSearchResult.getId ( )
/**
* return the internalId for the record returned in this row.
* @method
* @memberOf nlobjSearchResult
* @return {int}
*/
nlobjSearchResult.getRecordType ( )
/**
* return the recordtype for the record returned in this row.
* @method
* @memberOf nlobjSearchResult
* @return {string}
*/
nlobjSearchResult.getValue ( column )
/**
* return the value for this nlobjSearchColumn.
* @param {nlobjSearchColumn} column search result column
* @return {string}
*
* @method
* @memberOf nlobjSearchResult
*
* @since 2009.1
*/
nlobjSearchResult.getValue ( name , join , summary )
/**
* 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.getText ( column )
/**
* 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.getText ( name , join , summary )
/**
* 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.getAllColumns ( )
/**
* return an array of all nlobjSearchColumn objects returned in this search.
* @return {nlobjSearchColumn[]}
*
* @method
* @memberOf nlobjSearchResult
*
* @since 2009.2
*/
nlobjContext ( )
/**
* 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
*/
nlobjContext.getName ( )
/**
* return the name of the current user.
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2007.0
*/
nlobjContext.getUser ( )
/**
* return the internalId of the current user.
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2007.0
*/
nlobjContext.getRole ( )
/**
* return the internalId of the current user's role.
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2007.0
*/
nlobjContext.getRoleId ( )
/**
* return the script ID of the current user's role.
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2008.2
*/
nlobjContext.getRoleCenter ( )
/**
* return the internalId of the current user's center type.
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2008.2
*/
nlobjContext.getEmail ( )
/**
* return the email address of the current user.
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2007.0
*/
nlobjContext.getContact ( )
/**
* 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.getCompany ( )
/**
* return the account ID of the current user.
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2007.0
*/
nlobjContext.getDepartment ( )
/**
* return the internalId of the current user's department.
* @return {int}
*
* @method
* @memberOf nlobjContext
*
* @since 2007.0
*/
nlobjContext.getLocation ( )
/**
* return the internalId of the current user's location.
* @return {int}
*
* @method
* @memberOf nlobjContext
*
* @since 2007.0
*/
nlobjContext.getSubsidiary ( )
/**
* return the internalId of the current user's subsidiary.
* @return {int}
*
* @method
* @memberOf nlobjContext
*
* @since 2007.0
*/
nlobjContext.getExecutionContext ( )
/**
* 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.getRemainingUsage ( )
/**
* return the amount of usage units remaining for this script.
* @return {int}
*
* @method
* @memberOf nlobjContext
*
* @since 2007.0
*/
nlobjContext.getFeature ( name )
/**
* return true if feature is enabled, false otherwise
* @param {string} name
* @return {boolean}
*
* @method
* @memberOf nlobjContext
*
* @since 2009.2
*/
nlobjContext.getPermission ( name )
/**
* return current user's permission level (0-4) for this permission
* @param {string} name
* @return {int}
*
* @method
* @memberOf nlobjContext
*
* @since 2009.2
*/
nlobjContext.getPreference ( name )
/**
* return system or script preference selection for current user
* @param {string} name
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2009.2
*/
nlobjContext.getSessionObject ( name )
/**
* return value of session object set by script
* @param {string} name
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2009.2
*/
nlobjContext.setSessionObject ( name , value )
/**
* 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.getAllSessionObjects ( )
/**
* return an array containing the names of all keys used to set session objects
* @return {string[]}
*
* @method
* @memberOf nlobjContext
*
* @since 2009.2
*/
nlobjContext.getVersion ( )
/**
* return the NetSuite version for the current account
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2009.2
*/
nlobjContext.getEnvironment ( )
/**
* return the environment that the script is executing in: SANDBOX, PRODUCTION, BETA, INTERNAL
* @since 2008.2
*/
nlobjContext.getLogLevel ( )
/**
* return the logging level for the current script execution. Not supported in CLIENT scripts
* @since 2008.2
*/
nlobjContext.getScriptId ( )
/**
* return the script ID for the current script
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2009.2
*/
nlobjContext.getDeploymentId ( )
/**
* return the deployment ID for the current script
* @return {string}
*
* @method
* @memberOf nlobjContext
*
* @since 2009.2
*/
nlobjContext.getPercentComplete ( )
/**
* return the % complete specified for the current scheduled script execution
* @return {int}
*
* @method
* @memberOf nlobjContext
*
* @since 2009.2
*/
nlobjContext.setPercentComplete ( pct )
/**
* 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.getSetting ( type , name )
/**
* return a system/script setting. Types are SCRIPT, SESSION, FEATURE, PERMISSION
*
* @param {string} type
* @param {string} name
* @since 2007.0
* @deprecated
*/
nlobjContext.setSetting ( type , name , value )
/**
* set a system/script setting. Only supported type is SESSION
*
* @param {string} type
* @param {string} name
* @param {string} value
* @since 2007.0
* @deprecated
*/
nlobjContext.getColorPreferences ( )
/**
* 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
*/
nlobjError ( )
/**
* Return a new instance of nlobjError used system or user-defined error object.
*
* @classDescription Encapsulation of errors thrown during script execution.
* @return {nlobjError}
* @constructor
*/
nlobjError.getId ( )
/**
* return the error db ID for this error (if it was an unhandled unexpected error).
* @return {string}
*
* @method
* @memberOf nlobjError
*
* @since 2008.2
*/
nlobjError.getCode ( )
/**
* return the error code for this system or user-defined error.
* @return {string}
*
* @method
* @memberOf nlobjError
*
* @since 2008.2
*/
nlobjError.getDetails ( )
/**
* return the error description for this error.
* @return {string}
*
* @method
* @memberOf nlobjError
*
* @since 2008.2
*/
nlobjError.getStackTrace ( )
/**
* return a stacktrace containing the location of the error.
* @return {string[]}
*
* @method
* @memberOf nlobjError
*
* @since 2008.2
*/
nlobjError.getUserEvent ( )
/**
* return the userevent script name where this error was thrown.
* @return {string}
*
* @method
* @memberOf nlobjError
*
* @since 2008.2
*/
nlobjError.getInternalId ( )
/**
* return the internalid of the record if this error was thrown in an aftersubmit script.
* @return {int}
*
* @method
* @memberOf nlobjError
*
* @since 2008.2
*/
nlobjServerResponse ( )
/**
* 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
*/
nlobjServerResponse.getContentType ( )
/**
* return the Content-Type header in response
* @return {string}
*
* @method
* @memberOf nlobjServerResponse
*
* @since 2008.1
*/
nlobjServerResponse.getHeader ( name )
/**
* 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.getHeaders ( 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.getAllHeaders ( )
/**
* return an Array of all headers returned.
* @return {string[]}
*
* @method
* @memberOf nlobjServerResponse
*
* @since 2008.1
*/
nlobjServerResponse.getCode ( )
/**
* return the response code returned.
* @return {int}
*
* @method
* @memberOf nlobjServerResponse
*
* @since 2008.1
*/
nlobjServerResponse.getBody ( )
/**
* return the response body returned.
* @return {string}
*
* @method
* @memberOf nlobjServerResponse
*
* @since 2008.1
*/
nlobjServerResponse.getError ( )
/**
* return the nlobjError thrown via a client call to nlapiRequestURL.
* @return {nlobjError}
*
* @method
* @memberOf nlobjServerResponse
*
* @since 2008.1
*/
nlobjResponse ( )
/**
* 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
*/
nlobjResponse.addHeader ( name , value )
/**
* 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.setHeader ( 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.getHeader ( )
/**
* return the value of a response header.
* @param {string} name of header
* @return {string}
*
* @method
* @memberOf nlobjResponse
*
* @since 2008.2
*/
nlobjResponse.getHeaders ( name )
/**
* 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.getAllHeaders ( )
/**
* return an Array of all response headers
* @return {Object}
*
* @method
* @memberOf nlobjResponse
*
* @since 2008.2
*/
nlobjResponse.sendNoCache ( )
/**
* suppress caching for this response.
* @return {void}
*
* @method
* @memberOf nlobjResponse
*
* @since 2009.1
*/
nlobjResponse.setContentType ( type , filename , disposition )
/**
* 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.sendRedirect ( type , subtype , id , pagemode , parameters )
/**
* 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.write ( output )
/**
* write information (text/xml/html) to the response.
*
* @param {string} output
* @return {void}
* @method
* @memberOf nlobjResponse
*
* @since 2008.2
*/
nlobjResponse.writeLine ( output )
/**
* write line information (text/xml/html) to the response.
*
* @param {string} output
* @return {void}
* @method
* @memberOf nlobjResponse
*
* @since 2008.2
*/
nlobjResponse.writePage ( pageobject )
/**
* write a UI object page.
*
* @param {Object} pageobject page UI object: nlobjList|nlobjAssistant|nlobjForm|nlobjDashboard
* @return {void}
* @method
* @memberOf nlobjResponse
*
* @since 2008.2
*/
nlobjRequest ( )
/**
* 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
*/
nlobjRequest.getParameter ( name )
/**
* return the value of a request parameter.
*
* @param {string} name parameter name
* @return {string}
* @method
* @memberOf nlobjRequest
*
* @since 2008.2
*/
nlobjRequest.getParameterValues ( 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.getAllParameters ( )
/**
* return an Object containing all the request parameters and their values.
* @return {Object}
* @method
* @memberOf nlobjRequest
*
* @since 2008.2
*/
nlobjRequest.getLineItemValue ( group , name , line )
/**
* 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.getLineItemCount ( group )
/**
* return the number of lines in a sublist.
* @param {string} group sublist name
* @return {int}
*
* @method
* @memberOf nlobjRequest
*
* @since 2008.2
*/
nlobjRequest.getHeader ( name )
/**
* return the value of a request header.
* @param {string} name
* @return {string}
*
* @method
* @memberOf nlobjRequest
*
* @since 2008.2
*/
nlobjRequest.getAllHeaders ( )
/**
* return an Object containing all the request headers and their values.
* @return {Object}
*
* @method
* @memberOf nlobjRequest
*
* @since 2008.2
*/
nlobjRequest.getFile ( name )
/**
* return the value of an uploaded file.
* @param {string} name file field name
* @return {nlobjFile}
*
* @method
* @memberOf nlobjRequest
*
* @since 2009.1
*/
nlobjRequest.getAllFiles ( )
/**
* return an Object containing field names to file objects for all uploaded files.
* @return {Object}
*
* @method
* @memberOf nlobjRequest
*
* @since 2009.1
*/
nlobjRequest.getBody ( )
/**
* return the body of the POST request
* @return {string}
*
* @method
* @memberOf nlobjRequest
* @since 2008.1
*/
nlobjRequest.getURL ( )
/**
* return the URL of the request
* @return {string}
*
* @method
* @memberOf nlobjRequest
* @since 2008.1
*/
nlobjRequest.getMethod ( )
/**
* return the METHOD of the request
* @return {string}
*
* @method
* @memberOf nlobjRequest
* @since 2008.1
*/
nlobjPortlet ( )
/**
* 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
*/
nlobjPortlet.setTitle ( title )
/**
* set the portlet title.
*
* @param {string} title
* @since 2008.2
*/
nlobjPortlet.setHtml ( html )
/**
* set the entire contents of the HTML portlet (will be placed inside a
... | ).
*
* @param {string} html
* @since 2008.2
*/nlobjPortlet.addColumn ( name , type , label , align )
/**
* 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.addEditColumn ( column , showView , showHref )
/**
* 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.addRow ( row )
/**
* add a row (nlobjSearchResult or Array of name-value pairs) to this LIST portlet.
*
* @param {string[]|nlobjSearchResult} row
* @since 2008.2
*/
nlobjPortlet.addRows ( rows )
/**
* add multiple rows (Array of nlobjSearchResults or name-value pair Arrays) to this LIST portlet.
*
* @param {string[][]|nlobjSearchResult[]} rows
* @since 2008.2
*/
nlobjPortlet.addField ( name , type , label , source )
/**
* 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.setSubmitButton ( url , label )
/**
* 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.addLine ( text , url , indent )
/**
* 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
*/
nlobjList ( )
/**
* Return a new instance of nlobjList used for scriptable list page.
*
* @classDescription UI Object page type used for building lists
* @return {nlobjList}
* @constructor
*/
nlobjList.setTitle ( title )
/**
* set the page title.
*
* @param {string} title
* @since 2008.2
*/
nlobjList.setStyle ( style )
/**
* set the global style for this list: grid|report|plain|normal.
*
* @param {string} style overall style used to render list
* @since 2008.2
*/
nlobjList.setScript ( script )
/**
* 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.addColumn ( name , type , label , align )
/**
* 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.addEditColumn ( column , showView , showHref )
/**
* 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.addRow ( row )
/**
* 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.addRows ( rows )
/**
* 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.addButton ( name , label , script )
/**
* 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.addPageLink ( type , title , url )
/**
* 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 ( )
/**
* 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
*/
nlobjForm.setTitle ( title )
/**
* set the page title.
*
* @param {string} title
* @since 2008.2
*/
nlobjForm.addTitleHtml ( html )
/**
* set additional title Html. INTERNAL ONLY
*
* @param {string} title
* @since 2008.2
*/
nlobjForm.setScript ( script )
/**
* 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.setFieldValues ( values )
/**
* set the values for all the fields on this form.
*
* @param {Object} values Object containing field name/value pairs
* @since 2008.2
*/
nlobjForm.addPageLink ( type , title , url )
/**
* 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.addButton ( name , label , script )
/**
* 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.getButton ( name )
/**
* get a button from this form by name.
* @param {string} name
* @return {nlobjButton}
*
* @method
* @memberOf nlobjForm
*
* @since 2009.2 add
*/
nlobjForm.addResetButton ( label )
/**
* add a reset button to this form.
*
* @param {string} [label] label for this button. defaults to "Reset"
* @return {nlobjButton}
*
* @since 2008.2
*/
nlobjForm.addSubmitButton ( 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.addTab ( name , 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.addField ( name , type , label , sourceOrRadio , tab )
/**
* 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.addCredentialField ( name , label , domain , scriptId , value , entityMatch , tab )
nlobjForm.addCredentialField ( name , label , domain , scriptId , value , entityMatch )
nlobjForm.addCredentialField ( name , label , domain , scriptId , value )
nlobjForm.addSubTab ( name , label , 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.addSubList ( name , type , 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.insertTab ( tab , nexttab )
/**
* 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.insertField ( field , nextfld )
/**
* 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.insertSubTab ( subtab , nextsubtab )
/**
* 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.insertSubList ( sublist , nextsublist )
/**
* 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.getTab ( name )
/**
* return a tab (nlobjTab) on this form.
*
* @param {string} name tab name
* @return {nlobjTab}
*
* @since 2008.2
*/
nlobjForm.getField ( name , radio )
/**
* 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.getSubTab ( name )
/**
* return a subtab (nlobjTab) on this form.
*
* @param {string} name subtab name
* @return {nlobjTab}
*
* @since 2008.2
*/
nlobjForm.getSubList ( name )
/**
* return a sublist (nlobjSubList) on this form.
*
* @param {string} name sublist name
* @return {nlobjSubList}
*
* @since 2008.2
*/
nlobjForm.addFieldGroup ( name , label , tab )
/**
* 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
*/
nlobjAssistant ( )
/**
* 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
*/
nlobjAssistant.setTitle ( title )
/**
* set the page title.
* @param {string} title
* @return {void}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.setScript ( script )
/**
* 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.setSplash ( title , text1 , text2 )
/**
* 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.setShortcut ( show )
/**
* 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.setFieldValues ( values )
/**
* 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.setOrdered ( ordered )
/**
* 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.setNumbered ( numbered )
/**
* 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.isFinished ( )
/**
* return true if all the steps have been completed.
* @return {boolean}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.setFinished ( html )
/**
* 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.hasError ( )
/**
* return true if the assistant has an error message to display for the current step.
* @return {boolean}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.setError ( html )
/**
* 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.setCurrentStep ( step )
/**
* 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.addStep ( name , label )
/**
* 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.addField ( name , type , label , source , group )
/**
* 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.addSubList ( name , type , label )
/**
* 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.addFieldGroup ( name , 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.getStep ( name )
/**
* return an assistant step on this page.
* @param {string} name step name
* @return {nlobjAssistantStep}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.getField ( name )
/**
* return a field on this page.
* @param {string} name field name
* @return {nlobjField}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.getSubList ( name )
/**
* return a sublist on this page.
* @param {string} name sublist name
* @return {nlobjSubList}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.getFieldGroup ( name )
/**
* return a field group on this page.
* @param {string} name field group name
* @return {nlobjFieldGroup}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.getAllSteps ( )
/**
* return an array of all the assistant steps for this assistant.
* @return {nlobjAssistantStep[]}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.getAllFields ( )
/**
* return an array of the names of all fields on this page.
* @return {string[]}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.getAllSubLists ( )
/**
* return an array of the names of all sublists on this page .
* @return {string[]}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.getAllFieldGroups ( )
/**
* return an array of the names of all field groups on this page.
* @return {string[]}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.getLastAction ( )
/**
* return the last submitted action by the user: next|back|cancel|finish|jump
* @return {string}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.getLastStep ( )
/**
* return step from which the last submitted action came from
* @return {nlobjAssistantStep}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.getNextStep ( )
/**
* 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.getCurrentStep ( )
/**
* return current step set via nlobjAssistant.setCurrentStep(step)
* @return {nlobjAssistantStep}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.getStepCount ( )
/**
* return the total number of steps in the assistant
* @return {int}
*
* @method
* @memberOf nlobjAssistant
*
* @since 2009.2
*/
nlobjAssistant.sendRedirect ( response )
/**
* 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
*/
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
*
* @classDescription Core descriptor for fields used to define records and also used to build pages and portlets.
* @return {nlobjField}
* @constructor
*/
nlobjField.getName ( )
/**
* return field name.
* @return {string}
*
* @method
* @memberOf nlobjField
*
* @since 2009.2
*/
nlobjField.getLabel ( )
/**
* return field label.
* @return {string}
*
* @method
* @memberOf nlobjField
*
* @since 2009.2
*/
nlobjField.getType ( )
/**
* return field type.
* @return {string}
*
* @method
* @memberOf nlobjField
*
* @since 2009.2
*/
nlobjField.isHidden ( )
/**
* return true if field is hidden.
* @return {boolean}
*
* @method
* @memberOf nlobjField
*
* @since 2009.2
*/
nlobjField.isMandatory ( )
/**
* return true if field is mandatory.
* @return {boolean}
*
* @method
* @memberOf nlobjField
*
* @since 2009.2
*/
nlobjField.isDisabled ( )
/**
* return true if field is disabled.
* @return {boolean}
*
* @method
* @memberOf nlobjField
*
* @since 2009.2
*/
nlobjField.setLabel ( label )
/**
* 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.setAlias ( alias )
/**
* 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.setDefaultValue ( value )
/**
* 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.setDisabled ( disabled )
/**
* 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.setMandatory ( mandatory )
/**
* 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.setMaxLength ( maxlength )
/**
* 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.setDisplayType ( type )
/**
* 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.setBreakType ( breaktype )
/**
* 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.setLayoutType ( type , 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.setLinkText ( text )
/**
* 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.setDisplaySize ( width , height )
/**
* 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.setPadding ( padding )
/**
* 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.setHelpText ( help , inline )
/**
* 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.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
*
* @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
*/
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.
*
* @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
*/
nlobjSubList.setLabel ( label )
/**
* 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.setHelpText ( help )
/**
* 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.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
*
* @param {string} type
* @since 2008.2
*/
nlobjSubList.setLineItemValue ( field , line , value )
/**
* 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.setLineItemMatrixValue ( field , line , column , 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.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
*
* @param {string[][], nlobjSearchResult[]} values
* @since 2008.2
*/
nlobjSubList.getLineItemCount ( group )
/**
* Return the number of lines in a sublist.
*
* @param {string} group sublist name
*
* @method
* @memberOf nlobjSubList
* @since 2010.1
*/
nlobjSubList.addField ( name , type , label , source )
/**
* 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.setUniqueField ( fldnam )
/**
* 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.addButton ( name , label , script )
/**
* 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.addRefreshButton ( )
/**
* 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.addMarkAllButtons ( )
/**
* add "Mark All" and "Unmark All" buttons to this sublist of type "list".
*
* @method
* @memberOf nlobjSubList
*
* @since 2008.2
*/
nlobjColumn ( )
/**
* 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
*/
nlobjColumn.setLabel ( label )
/**
* set the header name for this column.
*
* @param {string} label the label for this column
*
* @method
* @memberOf nlobjColumn
*
* @since 2008.2
*/
nlobjColumn.setURL ( value , perRow )
/**
* 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.addParamToURL ( param , 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
*/
nlobjTab ( )
/**
* 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
*/
nlobjTab.setLabel ( label )
/**
* 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.setHelpText ( help )
/**
* 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
*/
nlobjAssistantStep ( )
/**
* 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
*/
nlobjAssistantStep.setLabel ( label )
/**
* 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.setHelpText ( help )
/**
* 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.getStepNumber ( )
/**
* 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.getFieldValue ( name )
/**
* 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.getFieldValues ( 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.getLineItemCount ( group )
/**
* 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.getLineItemValue ( group , name , line )
/**
* 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.getAllFields ( )
/**
* 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.getAllLineItems ( )
/**
* 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.getAllLineItemFields ( group )
/**
* 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
*/
nlobjFieldGroup ( )
/**
* 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
*/
nlobjFieldGroup.setLabel ( label )
/**
* set the label for this field group.
* @param {string} label display label for field group
* @return {nlobjFieldGroup}
*
* @method
* @memberOf nlobjFieldGroup
*
* @since 2009.2
*/
nlobjFieldGroup.setCollapsible ( collapsible , defaultcollapsed )
/**
* 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.setSingleColumn ( singleColumn )
/**
* 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.setShowBorder ( showBorder )
/**
* 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
*/
nlobjButton ( )
/**
* Return a new instance of nlobjButton.
*
* @classDescription buttons used for triggering custom behaviors on pages.
* @return {nlobjButton}
* @constructor
*
* @since 2009.2
*/
nlobjButton.setLabel ( label )
/**
* set the label for this button.
* @param {string} label display label for button
* @return {nlobjButton}
*
* @method
* @memberOf nlobjButton
*
* @since 2008.2
*/
nlobjButton.setDisabled ( disabled )
/**
* 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
*/
nlobjSelectOption ( )
/**
* 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
*/
nlobjSelectOption.getId ( )
/**
* return internal ID for select option
* @return {string}
*
* @method
* @memberOf nlobjSelectOption
*
* @since 2009.2
*/
nlobjSelectOption.getText ( )
/**
* return display value for select option.
* @return {string}
*
* @method
* @memberOf nlobjSelectOption
*
* @since 2009.2
*/