DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'



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.
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 persist.
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

Boolean
 

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

Boolean
 

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

Boolean
 

deprecated

Gets the deprecate info for this element

Returns

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

encapsulation

The encapsulation mode of this persist. 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.
- Hide Dataproviders (checked by default)
- Hide Foundset (checked by default)
- Hide Controller (checked by default)
- Hide Elements (checked by default)

Returns

Number - the encapsulation mode/level of the persist.
 

foreignDataSource

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

Returns

String
 

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

String
 

joinType

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

Returns

Number
 

name

The name of the relation.

Returns

String
 

primaryDataSource

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

Returns

String