Entity attributes collection

Slice of attributes with type Document

Indicate how entity content is cached on the client side.

Entity caption in plural

Entity caption in singular

Reference to connection definition (for extended domain only)

Data source connection name

Custom settings

Optional dbExtensions (for extended domain info)

Optional dbKeys (for extended domain info)

Entity description

Name of attribute witch used as a display value in lookup

Documentation

Entity methods, allowed for current logged-in user in format {method1: 1, method2: 1}. 1 mean method is allowed Empty for server-side domain - use entity.haveAccessToMethod to check method is accessible for user

This is a Full Text Search entity

Indicate this entity is a many-to-many storage for attributes of type "Many"

Indicate this entity is a UNITY for someone

Optional mapping of entity to physical data (for extended domain info only). Calculated from a entity mapping collection in accordance with application connection configuration

Collection of entity mixins

Name of model where entity is defined (in case entity is overridden - see overridesBy)

Entity name

CSV model names where entity is overridden

Internal short alias

Add entity level method. Client can call such methods remotely. Also such methods are the subjects of ELS.

Property named methodName with a type function should be added to the entity namespace. Such functions accept single parameter of type ubMethodParams

Don't add methods what do not called from client using {@UBEntity#addMethod}!

Warning: do not call UBEntity.addMethod from inside function or conditions. This code evaluated during thread initialization and each thread must add method in the same manner.

  
      //consider entity with code `my_entity` exists. Inside my_entity.js file):
 var me = my_entity;
 me.entity.addMethod('externalMethod');
 // @param {ubMethodParams} ctx <- here must be JSDoc comment format
 me.externalMethod = function (ctx) {
   let params = ctx.mParams
   let a = params.a || 1
   let b = params.b || 1
   params.multiplyResult = a*b
 }

 // now from client side you can call
 $App.connection.query({entity: 'my_entity', method: 'externalMethod', a: 10, b:20}).then(function(result){
   console.log(' 10 * 20 = ', result.multiplyResult); // will put to log "10 * 20 = 200"
 })
  

Return a JSON representation entity WITHOUT properties which have default values Result is very close to meta file.

WARNING use carefully inside server thread - method is slow

Get entity attribute by code. Return undefined if attribute is not found

Checks entity has attribute(s) and throw error if not

Checks if entity has mixin. Throw if mixin does not exist or not enabled

Iterates over entity attributes. The iteratee is invoked with three arguments: (UBEntityAttribute, attributeName, UBEntityAttributes)

Filters attributes by properties

  
      // return all attributes where property dataType equal Document
   domain.get('uba_user').filterAttribute({dataType: 'Document'});
  

Get entity attribute by code. Throw error if attribute is not found

Returns array of entity attribute`s names

Return array of conversion rules for raw server response data

Returns description attribute name (descriptionAttribute metadata property) If descriptionAttribute is empty - fallback to attribute with code caption

Returns an array of UBEntityAttribute with "Entity" data type and pointing to this entity (associatedEntity === this entity) and such relation should be visible in the UI "Details" menu.

Excluded attributes are:

• mi_* attributes
• attributes with customSetting.hiddenInDetails === true
• all attributes for entities user do not have access to the select method

Returns entity attribute. Understand complex attributes like firmID.firmType.code

Returns information about attribute and attribute entity. Understand complex attributes like firmID.firmType.code

Return:

Either attribute information or undefined if chain not points to attribute

  
      UB.connection.domain.get('cdn_country').getEntityAttributeInfo('mi_modifyUser.name')
 // {entity: 'uba_user', attribute: 'name', parentAttribute: {code: mi_modifyUser, dataType: 'Entity', ....}}
  

Return an entity caption to display on UI

Return entity description

For each attribute of type Entity from fieldList add entity code to result (duplicates are removed)

Checks if entity has enabled mixin with specified code

Checks if current user has access to at last one of specified methods

Checks if current user has access to a specified entity method

Checks if current user has access to ALL the specified methods

Get entity mixin by code. Returns undefined if mixin is not found