Child pages
  • JSRelation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Hidden
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

For more information see Relations

HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Constants Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#INNER_JOIN
Constant for set/get the joinType of a JSRelation.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#LEFT_OUTER_JOIN
Constant for set/get the joinType of a JSRelation.

HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#allowCreationRelatedRecords
Flag that tells if related records can be created through this relation.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#foreignDataSource
Qualified name of the foreign data source.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#name
The name of the relation.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#primaryDataSource
Qualified name of the primary data source.

HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSRelationItem[]
Table Cell (td)
#getRelationItems()
Returns an array of JSRelationItem objects representing the relation criteria defined for this relation.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
UUID
Table Cell (td)
#getUUID()
Returns the UUID of the relation object
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSRelationItem
Table Cell (td)
#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(primaryDataProviderID, operator, foreignColumnName)
Removes the desired relation item from the specified relation.

HTML Table
idconstant
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Constants Details
Table Body (tbody)
idINNER_JOIN
classnode
Table Row (tr)
idname
Table Cell (td)
INNER_JOIN
Table Row (tr)
iddes
Table Cell (td)
Constant for set/get the joinType of a JSRelation. It is also used in solutionModel.newRelation(...).
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', 'example_data', 'child_table', JSRelation.INNER_JOIN);
relation.joinType = JSRelation.LEFT_OUTER_JOIN;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idLEFT_OUTER_JOIN
classnode
Table Row (tr)
idname
Table Cell (td)
LEFT_OUTER_JOIN
Table Row (tr)
iddes
Table Cell (td)
Constant for set/get the joinType of a JSRelation. It is also used in solutionModel.newRelation(...).
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', 'example_data', 'child_table', JSRelation.INNER_JOIN);
relation.joinType = JSRelation.LEFT_OUTER_JOIN;
Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details
Table Body (tbody)
idallowCreationRelatedRecords
classnode
Table Row (tr)
idname
Table Cell (td)
allowCreationRelatedRecords
Table Row (tr)
iddes
Table Cell (td)

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
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', 'example_data', 'child_table', JSRelation.INNER_JOIN);
relation.allowCreationRelatedRecords = true;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idallowParentDeleteWhenHavingRelatedRecords
classnode
Table Row (tr)
idname
Table Cell (td)
allowParentDeleteWhenHavingRelatedRecords
Table Row (tr)
iddes
Table Cell (td)

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
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', 'example_data', 'child_table', JSRelation.INNER_JOIN);
relation.allowParentDeleteWhenHavingRelatedRecords = false;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddeleteRelatedRecords
classnode
Table Row (tr)
idname
Table Cell (td)
deleteRelatedRecords
Table Row (tr)
iddes
Table Cell (td)

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
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', 'example_data', 'child_table', JSRelation.INNER_JOIN);
relation.deleteRelatedRecords = true;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idforeignDataSource
classnode
Table Row (tr)
idname
Table Cell (td)
foreignDataSource
Table Row (tr)
iddes
Table Cell (td)
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
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', '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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idinitialSort
classnode
Table Row (tr)
idname
Table Cell (td)
initialSort
Table Row (tr)
iddes
Table Cell (td)

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
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', 'example_data', 'child_table', JSRelation.INNER_JOIN);
relation.initialSort = 'another_child_table_text asc';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idjoinType
classnode
Table Row (tr)
idname
Table Cell (td)
joinType
Table Row (tr)
iddes
Table Cell (td)
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
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', 'example_data', 'child_table', JSRelation.INNER_JOIN);
relation.joinType = JSRelation.LEFT_OUTER_JOIN;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idname
classnode
Table Row (tr)
idname
Table Cell (td)
name
Table Row (tr)
iddes
Table Cell (td)
The name of the relation.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', '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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idprimaryDataSource
classnode
Table Row (tr)
idname
Table Cell (td)
primaryDataSource
Table Row (tr)
iddes
Table Cell (td)
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
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', '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)
classlastDetailRow
Table Cell (td)


HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idgetRelationItems
classnode
Table Row (tr)
idname
Table Cell (td)
getRelationItems
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSRelationItem[]
Span
stylefloat: left; font-weight: bold;
idiets
getRelationItems
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns an array of JSRelationItem objects representing the relation criteria defined for this relation.
Table Row (tr)
idret
Table Cell (td)
Returns
JSRelationItem[] – An array of JSRelationItem instances representing the relation criteria of this relation.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetUUID
classnode
Table Row (tr)
idname
Table Cell (td)
getUUID
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
UUID
Span
stylefloat: left; font-weight: bold;
idiets
getUUID
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns the UUID of the relation object
Table Row (tr)
idret
Table Cell (td)
Returns
UUID
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', 'example_data', 'child_table', JSRelation.INNER_JOIN);
application.output(relation.getUUID().toString())
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idnewRelationItem
classnode
Table Row (tr)
idname
Table Cell (td)
newRelationItem
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSRelationItem
Span
stylefloat: left; font-weight: bold;
idiets
newRelationItem
Span
stylefloat: left;
idiets
(dataprovider, operator, foreinColumnName)
Table Row (tr)
iddes
Table Cell (td)
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)
idprs
Table Cell (td)
Parameters
{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)
idret
Table Cell (td)
Returns
JSRelationItem – A JSRelationItem instance representing the newly added relation item.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('parentToChild', 'example_data', 'parent_table', 'example_data', 'child_table', JSRelation.INNER_JOIN);
relation.newRelationItem('another_parent_table_id', '=', 'another_child_table_parent_id');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idremoveRelationItem
classnode
Table Row (tr)
idname
Table Cell (td)
removeRelationItem
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
removeRelationItem
Span
stylefloat: left;
idiets
(primaryDataProviderID, operator, foreignColumnName)
Table Row (tr)
iddes
Table Cell (td)
Removes the desired relation item from the specified relation.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{String} primaryDataProviderID – the primary data provider (column) name
{String} operator – the operator
{String} foreignColumnName – the foreign column name
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var relation = solutionModel.newRelation('myRelation', 'myServer', 'parentTable', '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)
classlastDetailRow
Table Cell (td)