UBEntityAttribute

@unitybase/cs-shared.UBDomain~ UBEntityAttribute

new UBEntityAttribute(attributeInfo, attributeCode, entity)

Entity attribute
Arguments:
  1. attributeInfo (object)
  2. attributeCode (string)
  3. entity (UBEntity)

Members

allowNull: boolean readonly

Attribute value can be empty or null

allowSort: boolean readonly

Allow order by clause by this attribute

associatedEntity: string readonly

Name of entity referenced by the attribute (for attributes of type Many - entity name from the AssociationManyData)

associationAttr: string readonly

associationManyData readonly

For attributes of type Many - name of the many-to-many table. UB create system entity with this name and generate table during DDL generation
Properties:
Type Description
string

caption: string readonly

cascadeDelete: Boolean readonly

For attributes of type Entity enable cascade deletion on application server level (not on database level)

code: string readonly

customSettings: object readonly

dataType: UBDomain.ubDataTypes readonly

Data type

defaultValue readonly

defaultView: boolean

If true - client should shows this attribute in auto-build forms and in '*' select fields

description: string readonly

documentation: string readonly

enumGroup readonly

For attributes of type Enum - code of enumeration group from ubm_enum.eGroup
Properties:
Name Type Description
enumGroup string

generateFK: boolean

For attributes of type Entity. If false - bypass foreign key generation by DDL generator

isMultiLang readonly

Properties:
Type Description
Boolean

isUnique: boolean readonly

mapping: UBEntityAttributeMapping readonly

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

name: string readonly

physicalDataType readonly

Properties:
Name Type Description
physicalDataType string

readOnly: Boolean readonly

Edition allowed (not verified by server side)

size: number readonly

storeName: string readonly

For attributes of type Document - name of BLOB store from application storeConfig. If empty - default store will be used

Methods

getAssociatedEntity() → UBEntity

Return associated entity or null if type of attribute !==Entity.