Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PropertyDef

/** A property definition describes a particular value of a business entity. Business entities are transacted as records, therefore properties and lists of properties are referred to as fields and records. Moreover, a list of property definitions is referred to as a record definition and is the metadata describing the read/write capabilities of a specific dialog model in use by a specific user in a specific workflow. Contains information that 'defines' a property {@link Prop} (name/value) An instance of the Property contains the actual data value.

Hierarchy

  • PropertyDef

Index

Constructors

constructor

  • new PropertyDef(canCauseSideEffects: boolean, contentType: string, displayLength: number, displayScale: number, format: string, length: number, propertyName: string, scale: number, semanticType: string, propertyType: string, writeAllowed: boolean, writeEnabled: boolean): PropertyDef
  • Parameters

    • canCauseSideEffects: boolean
    • contentType: string
    • displayLength: number
    • displayScale: number
    • format: string
    • length: number
    • propertyName: string
    • scale: number
    • semanticType: string
    • propertyType: string
    • writeAllowed: boolean
    • writeEnabled: boolean

    Returns PropertyDef

Properties

canCauseSideEffects

canCauseSideEffects: boolean

The canCauseSideEffects meta property indicates that writing to this property can cause LOCAL side effects (on the same business object). For example, changing a 'zipCode' property case cause the 'state' property to change. If a user interface changes a property that can cause side effects, it should refresh the associated business view.

contentType

contentType: string

displayLength

displayLength: number

Length of a type to be displayed. Some types are longer than what is practically needed by the application. This property is used to define the practical length used in user interfaces.

displayScale

displayScale: number

Scale of a decimal type to be displayed. Some decimal types are longer than what is practically needed by the application. This property is used to define the practical scale used in user interfaces.

format

format: string

The format property further describes the value using names that correlate, when possible, to the Open API formats. Some example format names are date, date-time, uuid, int32 and int64. The format name decimal is used to describe a string holding an arbitrary precision BCD value. For more information, see the Open API Spec at https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

length

length: number

Length of a type. This can be the length of a string or the length of a decimal.

propertyName

propertyName: string

The name of a business-data value

propertyType

propertyType: string

The type of business-data value. A valid type is either one of the OpenAPI basic values [array boolean integer null number object string] or a fully qualified type name that can be retrieved from the schema service.

scale

scale: number

Scale of a decimal type

semanticType

semanticType: string

Whereas 'type' and 'format' define the physical meaning of a property, the 'semanticType' adds meaningful insight into the usage of the property. For example, a 'decimal' type may be further defined semantically as a 'money' type.

writeAllowed

writeAllowed: boolean

writeEnabled

writeEnabled: boolean

Accessors

isBarcodeType

  • get isBarcodeType(): boolean

isBinaryType

  • get isBinaryType(): boolean

isBooleanType

  • get isBooleanType(): boolean

isCodeRefType

  • get isCodeRefType(): boolean

isDateTimeType

  • get isDateTimeType(): boolean

isDateType

  • get isDateType(): boolean

isDecimalType

  • get isDecimalType(): boolean

isDoubleType

  • get isDoubleType(): boolean

isEmailType

  • get isEmailType(): boolean

isFileAttachment

  • get isFileAttachment(): boolean

isFloatType

  • get isFloatType(): boolean

isGpsReadingType

  • get isGpsReadingType(): boolean

isHTMLType

  • get isHTMLType(): boolean

isInlineMediaStyle

  • get isInlineMediaStyle(): boolean

isIntType

  • get isIntType(): boolean

isLargeBinaryType

  • get isLargeBinaryType(): boolean

isListType

  • get isListType(): boolean

isLongType

  • get isLongType(): boolean

isMapLocationType

  • get isMapLocationType(): boolean

isMoneyType

  • get isMoneyType(): boolean

isNumericType

  • get isNumericType(): boolean

isObjRefType

  • get isObjRefType(): boolean

isPasswordType

  • get isPasswordType(): boolean

isPercentType

  • get isPercentType(): boolean

isSignatureType

  • get isSignatureType(): boolean

isStringType

  • get isStringType(): boolean

isTelephoneType

  • get isTelephoneType(): boolean

isTextBlock

  • get isTextBlock(): boolean

isTimeType

  • get isTimeType(): boolean

isURLType

  • get isURLType(): boolean

isUnformattedNumericType

  • get isUnformattedNumericType(): boolean

Generated using TypeDoc