Page History

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'

Divcache

styleindex	display:none

Div

id	description

For more information see Relations

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

...

Table Cell (td)
Number

...

true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Constants SummaryConstant for the joinType of a

...

Table Cell (td)
Number

...

JSRelation.

Constant for the joinType of a JSRelation.

...

Table Cell (td)
Number

...

Constant for the joinType of a JSRelation.

...

Table Cell (td)
Number

...

Constant for the joinType of a

...

padding	0px
width	80px

...

JSRelation.

servoy sSummary12%30%58%height: 30px;

...

Table Head (th)

colspan	2

Property Summary

...

Table Cell (td)
Boolean

...

3

Property Summary

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

...

Table Cell (td)
Boolean

...

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

...

Table Cell (td)
Boolean

...

Table Cell (td)
String

...

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

...

Qualified name of the foreign data source.

...

Table Cell (td)
String

...

A String which specified a set of sort options for the initial sorting of data

...

Table Cell (td)
Number

...

retrieved through this relation.

...

Table Cell (td)
String

...

The join type that is performed between the primary table and the foreign table.

...

The name of the relation.

...

Table Cell (td)
String

...

Qualified name of the primary data source.

...

servoy sSummary

...

padding	0px
width	80px

...

12%

30%

58%

height: 30px;

...

Table Head (th)

colspan	2

Method Summary

...

Table Cell (td)
JSRelationItem[]

...

Table Cell (td)
UUID

...

3

Methods Summary

Returns an array of JSRelationItem objects representing the relation criteria defined for this relation.

...

Returns the UUID of the relation object

...

Table Cell (td)
JSRelationItem

...

Creates a new relation item for this relation.

...

void

...

Removes the desired relation item from the specified relation.

...

constant

...

servoy sDetail

...

padding	0px
width	100%

...

2100%

height:30px

...

colspan	1

...

2

Constants Details

...

FULL_JOIN

...

name

...

FULL_JOIN

...

des

...

sIndent

Constant for the joinType of a

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


/** @type {QBSelect<db:/example_data/orders>} */
	var query = databaseManager.createSelect('db:/example_data/orders')
 /** @type {QBJoin<db:/example_data/order_details>} */
	var join = query.joins.add('db:/example_data/order_details', JSRelation.RIGHT_OUTER_JOIN, 'odetail')
	join.on.add(join.columns.orderid.eq(query.columns.orderid))

...

class	lastDetailRow

...

id	INNER_JOIN

Table Row (tr)

id	name

Table Cell (td)
INNER_JOIN

...

id	des

...

class	sIndent

...

 JSRelation. It is also used in solutionModel.newRelation(...).

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

INNER_JOIN

name

INNER_JOIN

des

sIndent

Constant for the joinType of a JSRelation. It is also used in solutionModel.newRelation(...)

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

SmartClient,WebClient,NGClient

sam

...

class	lastDetailRow

...

Sample

Div

class	sIndent

Code Block

language	javascript


var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.joinType = JSRelation.LEFT_OUTER_JOIN;

 /** @type {QBSelect<db:/example_data/orders>} */
	var query = databaseManager.createSelect('db:/example_data/orders')
 /** @type {QBJoin<db:/example_data/order_details>} */
	var join = query.joins.add('db:/example_data/order_details', JSRelation.INNER_JOIN, 'odetail')
	join.on.add(join.columns.orderid.eq(query.columns.orderid))

sIdent

javascript

lastDetailRow

LEFT_OUTER_JOIN

...

name

...

LEFT_OUTER_JOIN

...

des

...

sIndent

Constant for the joinType of a JSRelation. It is also used in solutionModel.newRelation(...)

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

id	sam

...

class	lastDetailRow

...

SmartClient,WebClient,NGClient

sam

Sample

Div

class	sIndent

Code Block

language	javascript


var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.joinType = JSRelation.LEFT_OUTER_JOIN;

 /** @type {QBSelect<db:/example_data/orders>} */
	var query = databaseManager.createSelect('db:/example_data/orders')
 /** @type {QBJoin<db:/example_data/order_details>} */
	var join = query.joins.add('db:/example_data/order_details', JSRelation.INNER_JOIN, 'odetail')
	join.on.add(join.columns.orderid.eq(query.columns.orderid))

sIdent

javascript

lastDetailRow

RIGHT_OUTER_JOIN

...

name

...

RIGHT_OUTER_JOIN

...

des

...

sIndent

Constant for the joinType of a

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


/** @type {QBSelect<db:/example_data/orders>} */
	var query = databaseManager.createSelect('db:/example_data/orders')
 /** @type {QBJoin<db:/example_data/order_details>} */
	var join = query.joins.add('db:/example_data/order_details', JSRelation.RIGHT_OUTER_JOIN, 'odetail')
	join.on.add(join.columns.orderid.eq(query.columns.orderid))

...

class	lastDetailRow

...

id	property
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

...

id	allowCreationRelatedRecords

Table Row (tr)

id	name

Table Cell (td)
allowCreationRelatedRecords

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

The default value of this flag is "false".

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.allowCreationRelatedRecords = true;

...

class	lastDetailRow

...

id	allowParentDeleteWhenHavingRelatedRecords

Table Row (tr)

id	name

Table Cell (td)
allowParentDeleteWhenHavingRelatedRecords

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.allowParentDeleteWhenHavingRelatedRecords = false;

...

class	lastDetailRow

...

id	deleteRelatedRecords

Table Row (tr)

id	name

Table Cell (td)
deleteRelatedRecords

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.deleteRelatedRecords = true;

...

class	lastDetailRow

...

id	foreignDataSource

Table Row (tr)

id	name

Table Cell (td)
foreignDataSource

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.primaryDataSource = 'db:/user_data/another_parent_table';
relation.foreignDataSource = 'db:/user_data/another_child_table';

...

class	lastDetailRow

...

id	initialSort

Table Row (tr)

id	name

Table Cell (td)
initialSort

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.initialSort = 'another_child_table_text asc';

...

class	lastDetailRow

...

id	joinType

Table Row (tr)

id	name

Table Cell (td)
joinType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.joinType = JSRelation.LEFT_OUTER_JOIN;

 /** @type {QBSelect<db:/example_data/orders>} */
	var query = databaseManager.createSelect('db:/example_data/orders')
 /** @type {QBJoin<db:/example_data/order_details>} */
	var join = query.joins.add('db:/example_data/order_details', JSRelation.INNER_JOIN, 'odetail')
	join.on.add(join.columns.orderid.eq(query.columns.orderid))

...

class	lastDetailRow

...

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the relation.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.name = 'anotherName';
var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.relationName = relation.name;

...

class	lastDetailRow

...

id	primaryDataSource

Table Row (tr)

id	name

Table Cell (td)
primaryDataSource

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.primaryDataSource = 'db:/user_data/another_parent_table';
relation.foreignDataSource = 'db:/user_data/another_child_table';

...

class	lastDetailRow

...

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	getRelationItems

Table Row (tr)

id	name

Table Cell (td)
getRelationItems

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSRelationItem[]

Span

style	font-weight: bold;

getRelationItems

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an array of JSRelationItem objects representing the relation criteria defined for this relation.

Table Row (tr)

id	ret

Table Cell (td)Returns
Div

class	sIndent

JSRelationItem[] –

 JSRelation. It is also used in solutionModel.newRelation(...).

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

propertyservoy sDetail2100%height:30px2Property DetailsallowCreationRelatedRecordsname

allowCreationRelatedRecords

des

sIndent

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

The default value of this flag is "false".

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

allowParentDeleteWhenHavingRelatedRecords

name

allowParentDeleteWhenHavingRelatedRecords

des

sIndent

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

The default value of this flag is "true".

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

deleteRelatedRecords

name

deleteRelatedRecords

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

foreignDataSource

name

foreignDataSource

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

initialSort

name

initialSort

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

joinType

name

joinType

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

name

des

sIndent

The name of the relation.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

primaryDataSource

name

primaryDataSource

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSRelationItem

Span

style	font-weight: bold;

newRelationItem

Span

functionservoy sDetail

2100%

height:30px

2

Methods Details

getRelationItems

name

getRelationItems()

des

sIndent

Returns an array of JSRelationItem objects representing the relation criteria defined for this relation.

ret

Returns

sIndent

An array of JSRelationItem instances representing the relation criteria of this relation.

clients

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var criteria = relation.getRelationItems();
for (var i=0; i<criteria.length; i++)
{
	var item = criteria[i];
	application.output('relation item no. ' + i);
	application.output('primary column: ' + item.primaryDataProviderID);
	application.output('operator: ' + item.operator);
	application.output('foreign column: ' + item.foreignColumnName);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	getUUID

Table Row (tr)

id	name

Table Cell (td)
getUUID

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

UUID

Span

style	font-weight: bold;

getUUID

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the UUID of the relation object

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

UUID

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
application.output(relation.getUUID().toString())

Table Row (tr)

class	lastDetailRow

Table Cell (td) Table Body (tbody)

id	newRelationItem-String_String_String

Table Row (tr)

id	name

Table Cell (td)
newRelationItem

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getUUID

name

getUUID()

des

sIndent

Returns the UUID of the relation object

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

newRelationItem

name

newRelationItem(dataprovider, operator, foreinColumnName)

Table Row (tr)idclass

des

Table Cell (td) Div

sIndent

Creates a new relation item for this relation. The primary dataprovider, the foreign data provider

 
and one relation operators (like '=' '!=' '>' '<') must be provided.

Table Row (tr)idtd

prsParameters
 DivclasssIndent{String} dataprovider – The name of the primary dataprovider.
 {String} operator – The operator used to relate the primary and the foreign dataproviders.
 {String} foreinColumnName –  Table Row (tr)idThe name of the foreign dataprovider.tdret
Returns
 DivclassJSRelationItem – sIndent
 Table Row (tr)
id name
 Table Cell (td)
removeRelationItem
 Table Row (tr)id sig
 Table Cell (td) Span
style margin-right: 5px;
void
 Span
style font-weight: bold;
removeRelationItem
 Span A JSRelationItem instance representing the newly added relation item.clients
 Table Row (tr)
id sam
 Table Cell (td)
Sample
 Div
class sIndent
 Code Block
language javascript

var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.newRelationItem('another_parent_table_id', '=', 'another_child_table_parent_id');
// for literals use a prefix
relation.newRelationItem(JSRelationItem.LITERAL_PREFIX + "'hello'",'=', 'mytextfield');
 Table Row (tr)class lastDetailRow
 Table Cell (td) Table Body (tbody)id removeRelationItem-String_String_String
Supported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowremoveRelationItemnameremoveRelationItem(primaryDataProviderID, operator, foreignColumnName) Table Row (tr)idclassdes Table Cell (td) DivsIndentRemoves the desired relation item from the specified relation. Table Row (tr)idtdprsParameters
 DivclasssIndent{String} primaryDataProviderID – the primary data provider (column) name
 {String} operator – the operator
 {String} foreignColumnName – the foreign column name
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
void
 Table Row (tr)
id sam
 Table Cell (td)
Sample
 Div
class sIndent
 Code Block
language javascript

var relation = solutionModel.newRelation('myRelation', 'db:/myServer/parentTable', 'db:/myServer/childTable', JSRelation.INNER_JOIN);
relation.newRelationItem('someColumn1', '=', 'someColumn2');
relation.newRelationItem('anotherColumn', '=', 'someOtherColumn');
relation.removeRelationItem('someColumn1', '=', 'someColumn2');
var criteria = relation.getRelationItems();
for (var i = 0; i < criteria.length; i++) {
	var item = criteria[i];
	application.output('primary column: ' + item.primaryDataProviderID);
	application.output('operator: ' + item.operator);
	application.output('foreign column: ' + item.foreignColumnName);
}
 Table Row (tr)class lastDetailRow
tdclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRow

Child pages

Versions Compared

Old Version 23

New Version Current

Key

FULL_JOIN

des

INNER_JOIN

INNER_JOIN

LEFT_OUTER_JOIN

des

RIGHT_OUTER_JOIN

allowCreationRelatedRecords

allowParentDeleteWhenHavingRelatedRecords

deleteRelatedRecords

foreignDataSource

initialSort

joinType

name

primaryDataSource

getRelationItems

allowCreationRelatedRecords

allowParentDeleteWhenHavingRelatedRecords

deleteRelatedRecords

foreignDataSource

initialSort

joinType

name

primaryDataSource

getRelationItems()

getUUID

newRelationItem

getUUID()

newRelationItem(dataprovider, operator, foreinColumnName)

removeRelationItem

removeRelationItem(primaryDataProviderID, operator, foreignColumnName)