On this page

$k. RelationTargetCondition

Extends

$k.QueryCondition

Methods

alternativesId() → {number}

Since: 4.1.0
Inherited From: $k.QueryCondition#alternativesId
Deprecated: This function is not supported any more

Returns:

Type:: number

parameter() → {string|undefined}

Returns the parameter name of the condition, if defined

Since: 4.1.0
Inherited From: $k.QueryCondition#parameter

Returns:

Type:: string | undefined

query() → {$k.StructuredQuery|undefined}

Version: Experimental feature, might be removed at any time
Since: 5.4.2
Inherited From: $k.QueryCondition#query

Returns:

The source query

Type:: $k.StructuredQuery | undefined

relationCondition() → {$k.HasRelationCondition|undefined}

Returns the relation condition

Since: 4.1.0

Returns:

Type:: $k.HasRelationCondition | undefined

setParameter(parameter)

Sets the parameter name of the condition

Parameters:

Name	Type	Description
`parameter`	string

Since: 4.1.0
Inherited From: $k.QueryCondition#setParameter

Throws:

If the condition cannot be modified
Type $k.exception.QueryError

setTransitivity(minopt, maxopt, booleanopt)

Set the transitivity of the relation.

Parameters:

Name	Type	Attributes	Default	Description
`min`	number	<optional>	1	Minimal number of relations to traverse. Must be an integer >= 1.
`max`	number	<optional>	Infinity	Maximum number of relations to traverse. If undefined or Infinity, any number of relations are traversed. Must be Infinity or an integer >= 1 and >= min
`boolean`	boolean	<optional>	true	True if only the shortest path between two elements should be traversed

Since: 4.1.0
See: $k.HasRelationCondition#setTransitivity

Throws:

If the transitivity values are not valid
Type $k.exception.QueryError

targetQuery() → {$k.StructuredQuery|undefined}

Returns the subquery for the relation target

Since: 4.1.0

Returns:

Type:: $k.StructuredQuery | undefined