Child pages
  • Relation
Skip to end of metadata
Go to start of metadata

Refresh page Mar 29, 2024 15:11

Supported Clients
SmartClient WebClient NGClient MobileClient

Property Summary
Boolean allowCreationRelatedRecords Flag that tells if related records can be created through this relation.
Boolean allowParentDeleteWhenHavingRelatedRecords Flag that tells if the parent record can be deleted while it has related records.
String comment
Boolean deleteRelatedRecords Flag that tells if related records should be deleted or not when a parent record is deleted.
String deprecated Gets the deprecate info for this element
Number encapsulation The encapsulation mode of this Relation.
String foreignDataSource Qualified name of the foreign data source.
String initialSort A String which specified a set of sort options for the initial sorting of data retrieved through this relation.
Number joinType The join type that is performed between the primary table and the foreign table.
String name The name of the relation.
String primaryDataSource Qualified name of the primary data source.

Property Details

allowCreationRelatedRecords

Flag that tells if related records can be created through this relation.

The default value of this flag is "false".

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

allowParentDeleteWhenHavingRelatedRecords

Flag that tells if the parent record can be deleted while it has related records.

The default value of this flag is "true".

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

comment

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 

deleteRelatedRecords

Flag that tells if related records should be deleted or not when a parent record is deleted.

The default value of this flag is "false".

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

deprecated

Gets the deprecate info for this element

Returns

String the deprecate info for this element or null if it is not deprecated

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

encapsulation

The encapsulation mode of this Relation. The following can be used/checked:

- Public (not a separate option - if none of the below options are selected)
- Hide in scripting; Module Scope - not available in scripting from any other context except the form itself. Available in designer for the same module.
- Module Scope - available in both scripting and designer but only in the same module.

Returns

Number the encapsulation mode/level of the persist.

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

foreignDataSource

Qualified name of the foreign data source. Contains both the name of the foreign
server and the name of the foreign table.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

initialSort

A String which specified a set of sort options for the initial sorting of data
retrieved through this relation.

Has the form "column_name asc, another_column_name desc, ...".

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

joinType

The join type that is performed between the primary table and the foreign table.
Can be "inner join" or "left outer join".

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

name

The name of the relation.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

primaryDataSource

Qualified name of the primary data source. Contains both the name of the primary server
and the name of the primary table.

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

  • No labels