Child pages
  • Relation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay:none

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'

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
allowCreationRelatedRecords
Flag that tells if related records can be created through this relation.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
allowParentDeleteWhenHavingRelatedRecords
Flag that tells if the parent record can be deleted while it has related records.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
deleteRelatedRecords
Flag that tells if related records should be deleted or not when a parent record is deleted.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
deprecated
Gets the deprecate info for this element
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
encapsulation
The encapsulation mode of this persist.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
foreignDataSource
Qualified name of the foreign data source.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
initialSort
A String which specified a set of sort options for the initial sorting of data
retrieved through this relation.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
joinType
The join type that is performed between the primary table and the foreign table.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
name
The name of the relation.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
primaryDataSource
Qualified name of the primary data source.



HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Details
Table Body (tbody)
idallowCreationRelatedRecords
Table Row (tr)
idname
Table Cell (td)

allowCreationRelatedRecords

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

The default value of this flag is "false".

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idallowParentDeleteWhenHavingRelatedRecords
Table Row (tr)
idname
Table Cell (td)

allowParentDeleteWhenHavingRelatedRecords

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

The default value of this flag is "true".

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddeleteRelatedRecords
Table Row (tr)
idname
Table Cell (td)

deleteRelatedRecords

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddeprecated
Table Row (tr)
idname
Table Cell (td)

deprecated

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the deprecate info for this element
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - the deprecate info for this element or null if it is not deprecated
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idencapsulation
Table Row (tr)
idname
Table Cell (td)

encapsulation

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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)

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - the encapsulation mode/level of the persist.
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idforeignDataSource
Table Row (tr)
idname
Table Cell (td)

foreignDataSource

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Qualified name of the foreign data source. Contains both the name of the foreign
server and the name of the foreign table.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idinitialSort
Table Row (tr)
idname
Table Cell (td)

initialSort

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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, ...".

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idjoinType
Table Row (tr)
idname
Table Cell (td)

joinType

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The join type that is performed between the primary table and the foreign table.
Can be "inner join" or "left outer join".
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idname
Table Row (tr)
idname
Table Cell (td)

name

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the relation.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idprimaryDataSource
Table Row (tr)
idname
Table Cell (td)

primaryDataSource

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Qualified name of the primary data source. Contains both the name of the primary server
and the name of the primary table.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)