Page History

Divcache
HTML Table
id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)FULL_JOIN

styleindex	display: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.

Div

id	description

For more information see Relations

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 Query Builder join.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)INNER_JOIN

Table Cell (td)LEFT_OUTER_JOIN

Constant for the joinType of a JSRelation.

Table Row (tr)

Table Cell (td)
Number

RIGHT_OUTER_JOIN

Constant for the joinType of a JSRelation.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Constant for the joinType of a Query Builder join.

HTML Table

idclassservoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead) Table Row (tr)style

Table Cell (td)
Boolean

Table Cell (td)allowCreationRelatedRecords

servoy sSummary

12%

30%

58%

height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Row (tr)

3

Property Summary

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
Table Row (tr)

Table Cell (td)
String

Table Cell (td)foreignDataSource

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 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
Table Row (tr)

Table Cell (td)
String

Table Cell (td)name

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

Table Cell (td)
String

Table Cell (td)primaryDataSource

The name of the relation.

Table Row (tr)

Qualified name of the primary data source.

HTML Table

idclassservoy sSummaryid

Colgroup Tag

Col

width	80px

Col

Table Head (thead) Table Row (tr)style Table Row (tr)

Table Cell (td)
JSRelationItem[]

Table Cell (td)getRelationItems()

servoy sSummary

12%

30%

58%

height: 30px;

Table Head (th)

colspan	2

Method Summary

3

Methods Summary

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

Table Row (tr)

Table Cell (td)
UUID

Table Cell (td)getUUID()

newRelationItem(dataprovider, operator, foreinColumnName)

Returns the UUID of the relation object

Table Row (tr)

Table Cell (td)
JSRelationItem

Table Cell (td)

Creates a new relation item for this relation.

Table Row (tr) Table Cell (td)

void

Table Cell (td)removeRelationItem(primaryDataProviderID, operator, foreignColumnName)

Removes the desired relation item from the specified relation.

HTML Table

constantclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col

Table Head (thead) Table Row (tr)style

height:30px

; Table Head (th)colspan

2

Constants Details

Table Body (tbody)idid

FULL_JOIN

Table Row (tr)

name

tdid

FULL_JOIN

Table Row (tr)

des

Table Cell (td) Divclass

sIndent

Constant for the joinType of a Query Builder join.

Table Row (tr)idtd

ret

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

Number Table Row (tr)

id	sam

SmartClient,WebClient,NGClient

sam

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))

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	INNER_JOIN

Table Row (tr)

id	name

Table Cell (td)
INNER_JOIN

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Table Row (tr)id

sIdent

javascript

lastDetailRow

INNER_JOIN

name

INNER_JOIN

des

sIndent

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

td

ret

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

Number Table Row (tr)

id	sam

Table Body (tbody)id

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))

Table Row (tr)

class	lastDetailRow

Table Cell (td)

sIdent

javascript

lastDetailRow

LEFT_OUTER_JOIN

Table Row (tr)idtd

name

LEFT_OUTER_JOIN

Table Row (tr)idclass

des

Table Cell (td) Div

sIndent

Table Row (tr)id

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

td

ret

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

Number Table Row (tr)

id	sam

Table Body (tbody)id

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))

Table Row (tr)

class	lastDetailRow

Table Cell (td)

sIdent

javascript

lastDetailRow

RIGHT_OUTER_JOIN

Table Row (tr)id

name

Table Cell (td)

RIGHT_OUTER_JOIN

tr

idclass

des

Table Cell (td) Div

sIndent

Constant for the joinType of a Query Builder join.

Table Row (tr)id

ret

Table Cell (td)

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

Number Table Row (tr)

id	sam

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id	allowCreationRelatedRecords

Table Row (tr)

id	name

Table Cell (td)
allowCreationRelatedRecords

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

SmartClient,WebClient,NGClient

sam

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))

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	property
class	servoy sDetail

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

Table Row (tr)id

ret

Table Cell (td)

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

Boolean Table Row (tr)

id	sam

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	allowParentDeleteWhenHavingRelatedRecords

Table Row (tr)

id	name

Table Cell (td)
allowParentDeleteWhenHavingRelatedRecords

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

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.allowCreationRelatedRecords = true;

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

Table Row (tr)idtd

ret

Returns

div

sIndent

clients

classid

Supported Clients

sIndent

Boolean Table Row (tr)

SmartClient,WebClient,NGClient

sam

Table Cell (td)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	deleteRelatedRecords

Table Row (tr)

id	name

Table Cell (td)
deleteRelatedRecords

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

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;

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

Table Row (tr)idtd

ret

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

Boolean Table Row (tr)

id	sam

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	foreignDataSource

Table Row (tr)

id	name

Table Cell (td)
foreignDataSource

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

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.deleteRelatedRecords = true;

sIdent

javascript

lastDetailRow

foreignDataSource

name

foreignDataSource

des

sIndent

Qualified name of the foreign data source. Contains both the name of the foreign

Table Row (tr)id

server and the name of the foreign table.

td

ret

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

String Table Row (tr)

id	sam

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	initialSort

Table Row (tr)

id	name

Table Cell (td)
initialSort

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

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.primaryDataSource = 'db:/user_data/another_parent_table';
relation.foreignDataSource = 'db:/user_data/another_child_table';

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.

Table Row (tr)id

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

td

ret

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

String Table Row (tr)

id	sam

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	joinType

Table Row (tr)

id	name

Table Cell (td)
joinType

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

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.initialSort = 'another_child_table_text asc';

sIdent

javascript

lastDetailRow

joinType

name

joinType

des

sIndent

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

Table Row (tr)id

Can be "inner join" or "left outer join".

td

ret

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

Number Table Row (tr)

id	sam

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

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

name

des

sIndent

The name of the relation.

Table Row (tr)id

ret

Table Cell (td)

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

String Table Row (tr)

id	sam

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	primaryDataSource

Table Row (tr)

id	name

Table Cell (td)
primaryDataSource

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

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.name = 'anotherName';
var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.relationName = relation.name;

sIdent

javascript

lastDetailRow

primaryDataSource

name

primaryDataSource

des

sIndent

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

Table Row (tr)id

and the name of the primary table.

ret

Table Cell (td)

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

String Table Row (tr)

id	sam

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

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

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.primaryDataSource = 'db:/user_data/another_parent_table';
relation.foreignDataSource = 'db:/user_data/another_child_table';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

sIdent

javascript

lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetRelationItemsname

getRelationItems()

des

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

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

sIndent

clients

class	sIndent

JSRelationItem[] - An array of JSRelationItem instances representing the relation criteria of this relation.

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

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getUUID

name

getUUID()

des

sIndent

Returns the UUID of the relation object

Table Row (tr)idtd

ret

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

UUID Table Row (tr)

id	sam

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

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSRelationItem

Span

style	font-weight: bold;

newRelationItem

Span

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);
application.output(relation.getUUID().toString())

sIdent

javascript

lastDetailRow

newRelationItem

name

newRelationItem(dataprovider, operator, foreinColumnName)

tr

id Divclass

des

Table Cell (td)

sIndent

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

Table Row (tr)id

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

td

prs

Parameters

Divclass

sIndent{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.ret

Table Cell (td)

Returns

div

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

removeRelationItem

Span

sIndent

clients

class	sIndent

JSRelationItem - A JSRelationItem instance representing the newly added relation item.

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

Table Row (tr)

id	name

Table Cell (td)
removeRelationItem

Table Row (tr)

id	sig

Table Cell (td)id

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

removeRelationItem

name

removeRelationItem(primaryDataProviderID, operator, foreignColumnName)

Table Row (tr) Table Cell (td) Divclass

des

sIndent

Removes the desired relation item from the specified relation.

Table Row (tr)idtd

prs

Parameters

Divclass

sIndent{String} primaryDataProviderID - the primary data provider (column) name
{String} operator - the operator
{String} foreignColumnName - Table Row (tr)idthe foreign column nametdret

Returns

div

sIndent

clients

classid

Supported Clients

sIndent

void Table Row (tr)

SmartClient,WebClient,NGClient

sam

Table Cell (td) Table Row (tr)

class	lastDetailRow

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);
}

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 27

New Version 28

Key

FULL_JOIN

INNER_JOIN

INNER_JOIN

LEFT_OUTER_JOIN

RIGHT_OUTER_JOIN

allowCreationRelatedRecords

allowCreationRelatedRecords

allowParentDeleteWhenHavingRelatedRecords

allowParentDeleteWhenHavingRelatedRecords

deleteRelatedRecords

deleteRelatedRecords

foreignDataSource

foreignDataSource

initialSort

initialSort

joinType

joinType

name

name

primaryDataSource

primaryDataSource

getRelationItems

getRelationItems()

getUUID

getUUID()

newRelationItem

newRelationItem(dataprovider, operator, foreinColumnName)

removeRelationItem

removeRelationItem(primaryDataProviderID, operator, foreignColumnName)