Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Learn more about the functions ISNULLfunctions ISNULL, ISUNKNOWN, IFUNKOWNIFUNKNOWN, IS A, TYPE OF, ISACTIVE, GUID. toc

Overview 

...

minLevel2

...

FunctionDescription

...

...

Checks whether a value is unknown

...

Syntax

Code Block
ISNULL ( expression )
  • expression - Expression that is checked.

Return type

  • boolean - TRUE of the attribute is unknown, FALSE otherwise

Examples

Suppose the following data model.

...

ISUNKNOWNReplaces

...

bgColorwhite

ISUNKNOWN

...

a value if that value is unknown.

...

Syntax

Code Block
ISUNKNOWN ( expression , value )
  • expression- Expression of which the value has to be returned if that value is known.
  • value - Value to return if the expression value is unknown.

Return type

  • any type, equals the expression type

Examples

Suppose the following data model.

...

IFUNKNOWNAlternative notation of the ISUNKNOWN
UI Text Box
typenote

Both parameters of the ISUNKNOWN function must be of the same datatype. If they differ in datatype, you get this validation error in studio:

Could not find function: ISUNKNOWN matching arguments System.Collections.ArrayList

...

bgColorwhite

IFUNKNOWN

...

function, which increases readability especially for long expressions

...

The IFUNKNOWN function takes precendence over any other binary operator (except for the "NOT" operator).
For example, this means that the expression A.B AND C.D IFUNKNOWN FALSE will be interpreted as A.B AND (C.D IFUNKNOWN FALSE). You can use parentheses to influence this behavior, e.g. by writing (A.B AND C.D) IFUNKNOWN FALSE. 
For the "NOT" operator the following expression "X AND NOT B IFUNKNOWN FALSE", can also be read as "X AND ((NOT B) IFUNKNOWN FALSE)"

Syntax

Code Block
expression IFUNKNOWN value
  • expression- Expression of which the value has to be returned if that value is known.

  • value - Value to return if the expression value is unknown.

Return type

  • any type, equals the expression type

Examples

Suppose the following data model.

...

typenote

Both parameters of the IFUNKNOWN function must be of the same datatype. If they differ in datatype, you get this validation error in studio:

...

.

...

...

bgColorwhite

...

Checks the entity type of an

...

Syntax

Code Block
instance IS A entity_name
instance

...

.

...

entity_name - Name of the entity as string.

Return type

  • boolean

Examples

Suppose a domain model in which there is a singleton entity Residence that has a multivalued relation hasRooms with Room. Room is the base entity for singleton Kitchen and not singletons Bedroom and Bathroom.

If you want to determine the number of bedrooms is the residence:

  • COUNT ( COLLECT Room FROM Residence.hasRooms WHERE ( Room IS A “Bedroom” ) )

If you want to determine the number of bathrooms is the residence:

  • COUNT ( COLLECT Room FROM Residence.hasRooms WHERE ( Room IS A “Bathroom” ) )
TYPE OFDetermines the entity type of an instance.
ISACTIVEDetermines

...

bgColorwhite

TYPE OF

Use this function to determine the type of an instance. The function returns the name of the entity.

Syntax

Code Block
TYPE OF base_entity
  • base_entity - Name of the instance's base entity.

Return type

  • string

Examples

Suppose a domain model in which there is a singleton entity Residence that has a multivalued relation hasRooms with Room. Room is the base entity for singleton Kitchen and not singletons Bedroom and Bathroom.

  • for the Kitchen instance the expression ( TYPE OF Room ) = “Kitchen”
  • for the Bedroom instances the expression ( TYPE OF Room ) = “Bedroom”

...

bgColorwhite

ISACTIVE

...

if an instance of a specific entity type is currently

...

Code Block
ISACTIVE instances [WHERE condition]
  • instances - instances to search
  • condition - optional condition to limit the collection of instances to check

Return type

...

active

...

UI Text Box
typenote

Singletons are always active, so ISACTIVE <singleton> will always return TRUE 

Examples

Suppose the following data model.

...

.

...

...

bgColorwhite

GUID

...

GUIDGenerates a globally unique identifier which can later be used to uniquely mark and recognize a desired element.

...

 

Functions

Include Page
Miscellaneous function ISNULL
Miscellaneous function ISNULL


Include Page
Miscellaneous function ISUNKNOWN
Miscellaneous function ISUNKNOWN


Include Page
Miscellaneous function IFUNKNOWN
Miscellaneous function IFUNKNOWN


Include Page
Miscellaneous function IS A
Miscellaneous function IS A


Include Page
Miscellaneous function TYPE OF
Miscellaneous function TYPE OF


Include Page
Miscellaneous function ISACTIVE
Miscellaneous function ISACTIVE


Include Page
Miscellaneous function GUID
Miscellaneous function GUID

The GUIDs are represented as 32 hexadecimal digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters.

Syntax

Code Block
GUID()

Return type

  • String - the generated GUID

Examples

...