Child pages
  • JSRelation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Constants SummaryConstant for the joinType of a Query Builder join.Constant for the joinType of a JSRelation.Constant for the joinType of a JSRelation.Constant for the joinType of a Query Builder join.

servoy sSummary12%30%58%height: 30px;3Property SummaryFlag that tells if related records can be created through this relation.Flag that tells if the parent record can be deleted while it has related records.Flag that tells if related records should be deleted or not when a parent record is deleted.Qualified name of the foreign data source.A String which specified a set of sort options for the initial sorting of data retrieved through this relation.The join type that is performed between the primary table and the foreign table.The name of the relation.Qualified name of the primary data source.

servoy sSummary12%30%58%height: 30px;3Methods SummaryReturns an array of JSRelationItem objects representing the relation criteria defined for this relation.Returns the UUID of the relation objectCreates a new relation item for this relation.voidRemoves the desired relation item from the specified relation.

constantservoy sDetail2100%height:30px2Constants DetailsFULL_JOINname

FULL_JOIN

dessIndent
Constant for the joinType of a Query Builder join.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowINNER_JOINname

INNER_JOIN

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
LEFT_OUTER_JOINname

LEFT_OUTER_JOIN

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
RIGHT_OUTER_JOINname

RIGHT_OUTER_JOIN

dessIndent
Constant for the joinType of a Query Builder join.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

propertyservoy sDetail2100%height:30px2Property DetailsallowCreationRelatedRecordsname

allowCreationRelatedRecords

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowallowParentDeleteWhenHavingRelatedRecordsname

allowParentDeleteWhenHavingRelatedRecords

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
deleteRelatedRecordsname

deleteRelatedRecords

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
foreignDataSourcename

foreignDataSource

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
initialSortname

initialSort

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
joinTypename

joinType

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
namename

name

dessIndent
The name of the relation.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
primaryDataSourcename

primaryDataSource

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetRelationItemsname

getRelationItems()

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetUUIDname

getUUID()

dessIndent
Returns the UUID of the relation object
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newRelationItemname

newRelationItem(dataprovider, operator, foreinColumnName)

dessIndent
Creates a new relation item for this relation. The primary dataprovider, the foreign data provider 
and one relation operators (like '=' '!=' '>' '<') must be provided.
prs

Parameters

sIndentdataproviderThe name of the primary dataprovider.operatorThe operator used to relate the primary and the foreign dataproviders.foreinColumnNameThe name of the foreign dataprovider.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeRelationItemname

removeRelationItem(primaryDataProviderID, operator, foreignColumnName)

dessIndent
Removes the desired relation item from the specified relation.
prs

Parameters

sIndentprimaryDataProviderIDthe primary data provider (column) nameoperatorthe operatorforeignColumnNamethe foreign column name
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow