Page History

...

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#FULLFULL_JOIN Constant for the joinType of a Query Builder join.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#INNERINNER_JOIN Constant for the joinType of a JSRelation.

tbody

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#LEFTLEFT_OUTER_JOIN Constant for the joinType of a JSRelation.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#RIGHTRIGHT_OUTER_JOIN Constant for the joinType of a Query Builder join.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

tbody

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

tbody

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#allowCreationRelatedRecords allowCreationRelatedRecords Flag that tells if related records can be created through this relation.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#allowParentDeleteWhenHavingRelatedRecords allowParentDeleteWhenHavingRelatedRecords Flag that tells if the parent record can be deleted while it has related records.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#deleteRelatedRecords 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)
#foreignDataSource foreignDataSource Qualified name of the foreign data source.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#initialSort initialSort A String which specified a set of sort options for the initial sorting of data retrieved through this relation.

tbody

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#joinType joinType The join type that is performed between the primary table and the foreign table.

tbody

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#name name The name of the relation.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#primaryDataSource primaryDataSource Qualified name of the primary data source.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

tbody

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
JSRelationItem[]

Table Cell (td)
#getRelationItems getRelationItems() Returns an array of JSRelationItem objects representing the relation criteria defined for this relation.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
UUID

Table Cell (td)
#getUUID getUUID() Returns the UUID of the relation object

Table Row (tr)

Table Cell (td)
JSRelationItem

Table Cell (td)
#newRelationItem newRelationItem(dataprovider, operator, foreinColumnName) Creates a new relation item for this relation.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#removeRelationItem removeRelationItem(primaryDataProviderID, operator, foreignColumnName) Removes the desired relation item from the specified relation.

HTML Table

id	constant
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Constants Details

Table Body (tbody)

id	FULL_JOIN

Table Row (tr)

id	name

Table Cell (td)
FULL_JOIN

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for the joinType of a Query Builder 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


/** @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

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

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	LEFT_OUTER_JOIN

Table Row (tr)

id	name

Table Cell (td)
LEFT_OUTER_JOIN

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	RIGHT_OUTER_JOIN

Table Row (tr)

id	name

Table Cell (td)
RIGHT_OUTER_JOIN

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for the joinType of a Query Builder 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


/** @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

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

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

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;

...

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

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;

...

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

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;

...

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

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';

...

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

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';

...

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

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

...

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

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;

...

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

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';

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

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[]

...

- 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

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

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSRelationItem

Span

style	font-weight: bold;

newRelationItem

Span
(dataprovider, operator, foreinColumnName)

Table Row (tr)

id	des

Table Cell (td)

Div

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

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} dataprovider

...

- The name of the primary dataprovider.
{String} operator

...

- The operator used to relate the primary and the foreign dataproviders.
{String} foreinColumnName

...

- The name of the foreign dataprovider.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

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)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

removeRelationItem

Span
(primaryDataProviderID, operator, foreignColumnName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the desired relation item from the specified relation.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{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

Table Cell (td)

Child pages

Versions Compared

Old Version 23

New Version 24

Key

FULL_JOIN

INNER_JOIN

LEFT_OUTER_JOIN

RIGHT_OUTER_JOIN

allowCreationRelatedRecords

allowParentDeleteWhenHavingRelatedRecords

deleteRelatedRecords

foreignDataSource

initialSort

joinType

name

primaryDataSource

getRelationItems

getUUID

newRelationItem

removeRelationItem