Class: BusinessObject

Simplicite.Ajax.BusinessObject

new BusinessObject

Simplicité® business object.
Getting a new business object should use the Simplicite.Ajax.getBusinessObject() function instead of this constructor

Parameters:
Name Type Description
app Application Simplicite.Ajax instance
objName Object name
objInstName Object instance name, optional (defauts to ajax_<object name>)
Source:
  • businessobject.js, line 54

Members

count

Current search result count.

Source:
  • businessobject.js, line 90

crosstabdata

Current cross table data.

Source:
  • businessobject.js, line 114

filters

Current search filters. Use filters["<field name>"] or filters.<field name> to access to the filter value

Source:
  • businessobject.js, line 84

item

Current item. Use item["<field name>"] or item.<field name> to access to the field value

Source:
  • businessobject.js, line 78

list

Current search result array of items.

Source:
  • businessobject.js, line 96

locals

Local parameters

Source:
  • businessobject.js, line 120

maxpage

Current search result max page index (for paginated searches).

Source:
  • businessobject.js, line 102

metadata

Current meta data.

  • name: object name
  • instance: object instance name
  • fields: fields definition array
  • TO BE COMPLETED...

Source:
  • businessobject.js, line 68

page

Current search result page index (for paginated searches).

Source:
  • businessobject.js, line 108

Methods

action

Calls an object action and loads action result.

Parameters:
Name Type Description
callback Callback function({ data, redirect:{url,target} })
act Action name
params Optional parameters :
  • values: object of field/value
  • metadata: true to update the metadata in context UPDATE on form action or LIST on list action
  • async Asynchronous call (use default if absent) ?
  • error Custom error handler (use default error handler if absent) ?
Source:
  • businessobject.js, line 1996

addItem

Add item to list

Parameters:
Name Type Description
item list item
index optional creation index 00 01...
Source:
  • businessobject.js, line 491

completion

Calls an object completion for specified field and loads action result.

Parameters:
Name Type Description
callback Callback function called when loading is completed (completion result is passed to this function)
field Field name
req Completion request
params Optional parameters :
  • async Asynchronous call (use default if absent) ?
  • error Custom error handler (use default error handler if absent) ?
Source:
  • businessobject.js, line 2175

create

Creates and loads an item.

Parameters:
Name Type Description
callback Callback function called when loading is completed
item Item to be created (row ID field of the item must be set to Simplicite.Ajax.DEFAULT_ROW_ID), optional (if absent current item is used)
params Optional parameters :
  • inlineDocs Inline documents (true | 'images' only | 'infos' without content | array of fields) ?
  • inlineThumbs Inline image documents thumbnails (true | array of fields) ?
  • inlineObjs Inline objects fields items (true|false) ?
  • metadata: true to update the metadata in context UPDATE when created
  • target: true to get target object if any
  • async Asynchronous call (use default if absent) ?
  • error Custom error handler (use default error handler if absent) ?
  • progress Optional progress callback
Source:
  • businessobject.js, line 1623

crosstab

Loads cross table data for search filters.

Parameters:
Name Type Description
callback Callback function called when loading is completed
ctb Cross table name
filters Filters to be applied, optional (if absent, current filters are used)
params Optional parameters :
  • ztree get lines tree with sums and metadata
  • zstotal get sub-totals ?
  • zstcolor sub-totals color
  • zaxis change axis ordering [{name,order,type,method}]
  • async Asynchronous call (use default if absent) ?
  • error Custom error handler (use default error handler if absent) ?
Source:
  • businessobject.js, line 1912

crosstabChartImage

Gets cross table data chart JPG image for search filters.

Parameters:
Name Type Description
callback Callback function called when loading is completed
ctb Cross table name
filters Filters to be applied, optional (if absent, current filters are used)
params Optional parameters :
  • async Asynchronous call (use default if absent) ?
  • error Custom error handler (use default error handler if absent) ?
    Source:
    • businessobject.js, line 1963

    del

    Deletes item. Current item is set to undefined.

    Parameters:
    Name Type Description
    callback Callback function called when loading is completed
    item optional item to be deleted or rowId (if absent current item is used)
    params Optional parameters :
    • async Asynchronous call (use default if absent) ?
    • error Custom error handler (use default error handler if absent) ?
    Source:
    • businessobject.js, line 1753

    deleteAll

    Deletes all (selected) items.

    Parameters:
    Name Type Description
    callback Callback function called when deletion is completed
    params Optional parameters :
    • async Asynchronous call (use default if absent) ?
    • error Custom error handler (use default error handler if absent) ?
    Source:
    • businessobject.js, line 1828

    get

    Selects and loads an item for designated row ID (if row ID is Simplicite.Ajax.DEFAULT_ROW_ID, a defaut item for creation is returned with all default values applied).

    Parameters:
    Name Type Description
    callback Callback function called when loading is completed
    rowId Row ID, mandatory
    params Optional parameters object may include:
    • context: Init context (one of Simplicite.Ajax.CONTEXT_CREATE/UPDATE/DELETE/COPY constants)
    • metadata: true to update the metadata in context
    • inlineDocs: Inline documents (true | 'images' only | 'infos' without content | array of fields) ?
    • inlineThumbs: Inline image documents thumbnails (true | array of fields) ?
    • inlineObjs: Inline objects fields items (true|false) ?
    • fields: Array of field names to retrieve (if absent or undefined, all fields are retrieved)
    • parent: optional parent context {name,inst,field,rowId} to populate related fields (useful in CONTEXT_CREATE)
    • async: Asynchronous call (use default if absent or undefined) ?
    • error: Custom error handler (use default error handler if absent) ?
    • social: true to get posts count
    • share: true to get social share data
    • treeView: optional treeview name
    • treeDepth: search depth in tree
    • treeHistory: true update and get the user's trees history
    • treePath: optional tree path
      Source:
      • businessobject.js, line 957

      getAction

      Get action definition

      Parameters:
      Name Type Description
      name Action name
      Source:
      • businessobject.js, line 576

      getAgenda

      Get agenda definition

      Parameters:
      Name Type Description
      name Agenda name
      Source:
      • businessobject.js, line 728

      getArea

      Get area definition

      Parameters:
      Name Type Description
      n Area position
      Source:
      • businessobject.js, line 604

      getCount

      Count rows with filters and set count and maxpage in object.

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed
      filters Filters to be applied, optional (if absent, current filters are used)
      params Optional parameters { parent, view, metadata }
      Source:
      • businessobject.js, line 1479

      getCrosstab

      Get crosstab definition

      Parameters:
      Name Type Description
      name Crosstab name
      Source:
      • businessobject.js, line 646

      getCrosstabCubes

      Get crosstab cubes (data)

      Parameters:
      Name Type Description
      callback function(cubes)
      name Crosstab name
      params Optional async and error handler
      Source:
      • businessobject.js, line 685

      getField

      Gets field from fields array in meta-data (returns undefined if field is not found).

      Parameters:
      Name Type Description
      name Field name or Field
      id Optional list index/rowId
      Source:
      • businessobject.js, line 302

      getFieldArea

      Get field area definition

      Parameters:
      Name Type Description
      n Area name or position
      Source:
      • businessobject.js, line 632

      getFieldIndex

      Gets the field index in object

      Parameters:
      Name Type Description
      name Field name or Field
      Source:
      • businessobject.js, line 324

      getFieldOldValue

      Get old field value shorthand

      Source:
      • businessobject.js, line 368

      getFields

      Gets fields array from meta data (is undefined as long as meta data are not loaded using getMetaData).

      Source:
      • businessobject.js, line 236

      getFieldValue

      Get field value shorthand

      Parameters:
      Name Type Description
      name Field name or Field
      id Optional list rowId
      Source:
      • businessobject.js, line 342

      getFilters

      Loads current filters.

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed
      params Optional parameters :
      • context Init context (normally Simplicite.Ajax.CONTEXT_SEARCH constant), optional
      • reset Reset filters, optional
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      Source:
      • businessobject.js, line 1188

      getFiltersForSearch

      Loads current filters for search (equivalent to a getFilters done with the search init context Simplicite.Ajax.CONTEXT_SEARCH).

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed
      params Optional parameters
      Source:
      • businessobject.js, line 1276

      getForCopy

      Loads item for designated row ID for copy (equivalent to a get done with the copy init context Simplicite.Ajax.CONTEXT_COPY).

      Parameters:
      Name Type Description
      callback Callback function called when loading and context initialization is completed
      rowId Row ID, mandatory
      params Optional parameters (same as for get function)
      Source:
      • businessobject.js, line 1079

      getForCreate

      Loads default item for creation (equivalent to a get done on default row ID with the create init context Simplicite.Ajax.CONTEXT_CREATE).

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed
      params Optional parameters (same as for get function)
      Source:
      • businessobject.js, line 1041

      getForDelete

      Loads item for designated row ID for delete (equivalent to a get done with the delete init context Simplicite.Ajax.CONTEXT_DELETE).

      Parameters:
      Name Type Description
      callback Callback function called when loading and context initialization is completed
      rowId Row ID, mandatory
      params Optional parameters (same as for get function)
      Source:
      • businessobject.js, line 1098

      getForeignKeys

      Get foreign-key fields

      Source:
      • businessobject.js, line 410

      getForUpdate

      Loads item for designated row ID for update (equivalent to a get done with the update init context Simplicite.Ajax.CONTEXT_UPDATE).

      Parameters:
      Name Type Description
      callback Callback function called when loading and context initialization is completed
      rowId Row ID, mandatory
      params Optional parameters (same as for get function)
      Source:
      • businessobject.js, line 1060

      getHelp

      Gets context help from meta data (is undefined as long as meta data are not loaded using getMetaData).

      Source:
      • businessobject.js, line 228

      getId

      Gets Id from meta data.

      Source:
      • businessobject.js, line 179

      getImageURL

      Get URL of first image field

      Parameters:
      Name Type Description
      item object optional item (use field values if unset)
      Source:
      • businessobject.js, line 424

      getInstance

      Gets instance name from meta data.

      Source:
      • businessobject.js, line 195

      getItem

      Gets the current item

      Parameters:
      Name Type Description
      id Optional index/rowId to look in current list
      Source:
      • businessobject.js, line 469

      getLabel

      Gets label from meta data (is undefined as long as meta data are not loaded using getMetaData).

      Source:
      • businessobject.js, line 220

      Gets a link definition.

      Parameters:
      Name Type Description
      object Referenced object or name
      field Foreign key field or name
      Source:
      • businessobject.js, line 259

      getLinkedList

      Gets a linked list of an enum field

      Parameters:
      Name Type Description
      field Enum field name
      value Selected value(s) separated with ";"
      target Linked field
      lov Current linked list name
      callback function(target, new list {name, items})
      params Optional async and error handler
      Source:
      • businessobject.js, line 776

      Gets links array from meta data (is undefined as long as meta data are not loaded using getMetaData).

      Source:
      • businessobject.js, line 250

      getListItem

      Gets item in the current list

      Parameters:
      Name Type Description
      i index
      Source:
      • businessobject.js, line 1456

      getListPos

      Gets the position in current list, -1 if not found

      Parameters:
      Name Type Description
      rowId row Id to find
      Source:
      • businessobject.js, line 1466

      getListValue

      Gets value from list for specified code (returns undefined if code is not in list).

      Parameters:
      Name Type Description
      list List metadata (typically from a field metadata)
      code Code
      Source:
      • businessobject.js, line 874

      getMetaData

      Loads meta data for specified context.
      Sample usage:

      obj.getMetaData(function() {
      	alert("Meta data loaded for update of object " + this.getName());
      }, { context: app.CONTEXT_UPDATE });
      

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed
      params Optional parameters :
      • context Context (one of Simplicite.Ajax.CONTEXT_* constants)
      • contextParam Context single parameter (agenda name...)
      • parent Parent of PANELLIST { name, inst, field, rowId }
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      Source:
      • businessobject.js, line 142

      getName

      Gets name from meta data.

      Source:
      • businessobject.js, line 187

      getObjectField

      Gets an Object Field

      Parameters:
      Name Type Description
      f string | Simplicite.Ajax.ObjectField Field name or metadata
      data object Optional contextual data { value, message }
      Source:
      • objectfield.js, line 13

      getObjectParameter

      Get object parameter (unused but kept for forward compatibility because of deprecated synchronous usage)

      Source:
      • businessobject.js, line 926

      getOldValues

      Get old values

      Source:
      • businessobject.js, line 561

      getParameter

      Loads an object parameter.

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed (parameter is passed to this function)
      name Parameter name
      params Optional parameters :
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      Source:
      • businessobject.js, line 2135

      getParentObject

      Get parent business object of panel instance

      Source:
      • businessobject.js, line 890

      getParentObjectRefField

      Get foreign key of panel instance

      Source:
      • businessobject.js, line 894

      getPivotTable

      Alias for getCrosstab

      Source:
      • businessobject.js, line 658

      getPivotTableData

      Alias for getCrosstabCubes

      Source:
      • businessobject.js, line 707

      getPlacemap

      Get placemap definition

      Parameters:
      Name Type Description
      name Placemap name
      Source:
      • businessobject.js, line 714

      getPrintTemplate

      Get print definition

      Parameters:
      Name Type Description
      name Print template name
      Source:
      • businessobject.js, line 742

      getRootField

      Get the root field of reference, null when field belongs to object

      Parameters:
      Name Type Description
      field Field or name
      Source:
      • businessobject.js, line 386

      getRowId

      Gets current item row Id value (returns undefined if not current item is loaded).

      Source:
      • businessobject.js, line 1114

      getRowIdField

      Gets row Id field from meta data (returns undefined if row Id field name is undefined).

      Source:
      • businessobject.js, line 864

      getRowIdFieldName

      Gets row Id field name from meta data (is undefined as long as meta data are not loaded using getMetaData).

      Source:
      • businessobject.js, line 856

      getTransition

      Get transition definition

      Parameters:
      Name Type Description
      name Transition name
      Source:
      • businessobject.js, line 590

      getUserKeyFields

      Get user-key fields

      Source:
      • businessobject.js, line 397

      getValueForCode

      Gets list of values field value from code (returns code if not found or not a list of value field)

      Parameters:
      Name Type Description
      field Field
      code Field code
      Source:
      • businessobject.js, line 758

      getValues

      Get values (fields into item)

      Source:
      • businessobject.js, line 547

      getView

      Gets a view definition.

      Parameters:
      Name Type Description
      name View name
      Source:
      • businessobject.js, line 283

      getViews

      Gets views array from meta data (is undefined as long as meta data are not loaded using getMetaData).

      Source:
      • businessobject.js, line 275

      help

      Gets the long help.

      Parameters:
      Name Type Description
      callback Callback function called
      params Optional parameters :
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      Source:
      • businessobject.js, line 1881

      indexsearch

      Search from index and loads search result items.

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed
      request Index search request string
      params Optional parameters :
      • inlineDocs Inline documents (true | 'images' only | 'infos' without content | array of fields) ?
      • inlineThumbs Inline image documents thumbnails (true | array of fields) ?
      • inlineObjs Inline objects fields items (true|false) ?
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      • context optional context
      • parent optional parent { name, inst, field, rowId } to search references
      Source:
      • businessobject.js, line 1538

      isCopied

      Is copied record ?

      Source:
      • businessobject.js, line 903

      isFiltered

      Is object filtered ?

      Parameters:
      Name Type Description
      exclude Optional filters to ignore { field:value }
      Source:
      • businessobject.js, line 1215

      isLoaded

      Are metadata loaded ?

      Source:
      • businessobject.js, line 212

      isNew

      Is new record ?

      Source:
      • businessobject.js, line 899

      isOrdered

      Is object ordered ?

      Source:
      • businessobject.js, line 1241

      isRowIdField

      Checks whether a field is the row ID field.

      Parameters:
      Name Type Description
      f Field meta data
      Source:
      • businessobject.js, line 2226

      isTimestampField

      Checks whether a field is a timestamp field.

      Parameters:
      Name Type Description
      f Field meta data
      Source:
      • businessobject.js, line 2235

      localParameter

      Local parameter in object instance

      Parameters:
      Name Type Description
      name Parameter key name
      value Optional value (to get or set)
      Source:
      • businessobject.js, line 2158

      populate

      Populate item (e.g. after getForCreate and after having set foreign keys)

      Parameters:
      Name Type Description
      callback function function(item) callback with populated item
      item object Item to be populated, optional (if absent current item is used)
      params object Optional parameters:
      Properties
      Name Type Description
      inlineDocs boolean | string | array Inline documents: true | 'images' only | 'infos' without content | array of fields
      inlineThumbs boolean | array Inline image documents thumbnails: true | array of fields
      inlineObjs boolean Inline objects fields items
      userKeys boolean Get foreign user-keys
      async boolean Asynchronous call (use default if absent or undefined)
      error function Custom error handler (use default error handler if absent)
      Source:
      • businessobject.js, line 1145

      predefSearch

      Predefined search service (of user's private searches, public searches are protected)

      Parameters:
      Name Type Description
      callback Callback function
      method create|update|delete
      ps Predefined search to save { id, name, filters }
      params { async, error }
      Source:
      • businessobject.js, line 2201

      preferences

      Preferences service.

      Parameters:
      Name Type Description
      callback Callback function
      prefs optional preferences to save { list, search, actions }
      params Optional parameters :
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      Source:
      • businessobject.js, line 1854

      print

      Calls an object publication and loads publication result.

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed (publication result is passed to this function)
      prt Print template name
      params Optional parameters :
      • all Apply template to all items matching current filters (false by default, which means apply template only to current item) ?
      • mailing Apply template individually to all items matching current filter (false by default) ?
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      Source:
      • businessobject.js, line 2039

      remove

      Same as del function

      Source:
      • businessobject.js, line 1786

      removeArea

      Remove area in metadata if position exists

      Parameters:
      Name Type Description
      n Area position
      Source:
      • businessobject.js, line 618

      removeItem

      Remove item from list

      Parameters:
      Name Type Description
      id index/rowId in current list
      Source:
      • businessobject.js, line 505

      removeParameter

      Remove an object parameter.

      Parameters:
      Name Type Description
      callback Callback function called when completed
      name Parameter name
      params Optional parameters :
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      Source:
      • businessobject.js, line 2120

      resetFilters

      Reset filters (not orders)

      Source:
      • businessobject.js, line 1230

      resetGroupByFields

      Reset group by fields

      Source:
      • businessobject.js, line 1263

      resetOrders

      Reset orders (not filters)

      Source:
      • businessobject.js, line 1252

      resetValues

      reset values (item into fields)

      Parameters:
      Name Type Description
      old true to reset old values
      Source:
      • businessobject.js, line 530

      save

      Saves (create or update) and loads an item.

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed
      item Item to be saved, optional (if absent current item is used)
      params Optional parameters (see create or update method)
      Source:
      • businessobject.js, line 1595

      Search and loads search result items.

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed
      filters Optional filters to apply (if absent, current filters are used)
      params Optional parameters :
      • context Init context (normally one of Simplicite.Ajax.CONTEXT_LIST/PANELLIST/REFSELECT/DATAMAPSELECT/EXPORT/CROSSTAB/GRAPH/PRINTTMPL constant), optional
      • metadata: true to update the metadata in context, and items with { meta:{...}, data:{...} }, false to get the data directly
      • page Page index to retrieve (between 0 and maxpage), optional (if absent or set to -1 no pagination will be done, for pagination a first call must be done with pageIndex set to 0)
      • inlineDocs Inline documents (true | 'images' only | 'infos' without content | array of fields) ?
      • inlineThumbs Inline image documents thumbnails (true | array of fields) ?
      • inlineObjs Inline objects fields items (true|false) ?
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      • parent optional parent object { name, inst, field, rowId } in CONTEXT_PANELLIST
      • view optional view { name:viewname, item:position, home:true|false } in CONTEXT_LIST
      • history true to get rows histories
      • totals true to get the field aggregations
      • social true to get posts count for each row
      • visible true to get only visible fields
      • edit optional edit list mode 'new', 'rows' or 'upsert'
      • groupby true to get the group by result
      • partial true to get result for lazy-loading without changing the object data
      Source:
      • businessobject.js, line 1309

      searchForList

      Search and loads search result items for list (equivalent to a search done with the list init context Simplicite.Ajax.CONTEXT_LIST).

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed
      filters Filters to be applied, optional (if absent, current filters are used)
      params Optional parameters
      Source:
      • businessobject.js, line 1427

      searchForPanelList

      Search and loads search result items for panel list (equivalent to a search done with the list init context Simplicite.Ajax.CONTEXT_PANELLIST).

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed
      filters Filters to be applied, optional (if absent, current filters are used)
      params Optional parameters
      • parent optional parent object { name, inst, field } in CONTEXT_PANELLIST
      Source:
      • businessobject.js, line 1444

      select

      Same as get function

      Source:
      • businessobject.js, line 1033

      selectForCopy

      Same as getForCopy function

      Source:
      • businessobject.js, line 1089

      selectForCreate

      Same as getForCreate function

      Source:
      • businessobject.js, line 1051

      selectForDelete

      Same as getForDelete function

      Source:
      • businessobject.js, line 1108

      selectForUpdate

      Same as getForUpdate function

      Source:
      • businessobject.js, line 1070

      selectRow

      Select row(s)

      Parameters:
      Name Type Description
      sel 'all', 'page', 'none' or specific rowid (supports multiple ids separated with ';')
      callback function(ids)
      params Optional async and error handler
      Source:
      • businessobject.js, line 834

      setCrosstab

      Set crosstab definition

      Parameters:
      Name Type Description
      name Crosstab name
      meta Crosstab metadata
      Source:
      • businessobject.js, line 665

      setFieldOldValue

      Set old field value shorthand

      Source:
      • businessobject.js, line 376

      setFieldValue

      Set field value shorthand

      Parameters:
      Name Type Description
      name Field name or Field
      val Value
      id Optional list rowId
      Source:
      • businessobject.js, line 353

      setList

      Set a new list to field, does nothing when new list is the same.

      Parameters:
      Name Type Description
      field Enum field name
      list List name to load
      callback function(field,newList)
      params Optional async and error handler
      Source:
      • businessobject.js, line 803

      setListSize

      Sets the search size for pagination.

      Parameters:
      Name Type Description
      callback Callback function called when completed
      size Integer value
      params Optional parameters :
      Source:
      • businessobject.js, line 2105

      setParameter

      Sets (or remove) an object parameter and loads it back.

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed (parameter is passed to this function)
      name Parameter name
      value Parameter value (unset if null)
      params Optional parameters :
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      Source:
      • businessobject.js, line 2081

      setParent

      Store parent object in panel instance { name, inst, field, rowId, object }

      Source:
      • businessobject.js, line 883

      setPivotTable

      Alias for setCrosstab

      Source:
      • businessobject.js, line 676

      setRowId

      Sets current item row Id value.

      Source:
      • businessobject.js, line 1125

      setValues

      Set values (item into fields)

      Parameters:
      Name Type Description
      item values per field name, default: current item
      old true to copy values into old values ?
      id optional list index/rowId
      Source:
      • businessobject.js, line 447

      update

      Updates and loads an item.

      Parameters:
      Name Type Description
      callback Callback function called when loading is completed
      item Item to be updated, optional (if absent current item is used)
      params Optional parameters :
      • inlineDocs Inline documents (true | 'images' only | 'infos' without content | array of fields) ?
      • inlineThumbs Inline image documents thumbnails (true | array of fields) ?
      • inlineObjs Inline objects fields items (true|false) ?
      • metadata: true to update the metadata in context UPDATE
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      • context optional to specify when update occurs on a LIST
      • progress Optional progress callback
      • timestamp false to bypass timestamp check and update (silent update)
      • itemAction optional action parameters (during transition)
      Source:
      • businessobject.js, line 1692

      updateAll

      Updates all (selected) items.

      Parameters:
      Name Type Description
      callback Callback function called when update is completed
      item Item to be updated, optional (if absent current item is used)
      params Optional parameters :
      • async Asynchronous call (use default if absent) ?
      • error Custom error handler (use default error handler if absent) ?
      • progress Optional progress callback
      Source:
      • businessobject.js, line 1800