Olympe SDK

Class: RelatedTo

olympe.dc.api.predicates. RelatedTo

new RelatedTo( [destination])

Parameters:
Name Type Argument Description
destination olympe.dc.Tag <optional>
Implements:

Methods

clear(tag, index)

Unregister callback

Parameters:
Name Type Description
tag string
index string
Implements:

execute(tag)

Apply the predicate to given value

Parameters:
Name Type Description
tag string

of instance to test predicate
Implements:
Returns:

if predicates passes

Type
boolean

follow(relation)

Parameters:
Name Type Description
relation olympe.dc.registry.Relation
Returns:
Type
olympe.dc.api.predicates.RelatedTo

followRecursive(relation)

Parameters:
Name Type Description
relation olympe.dc.registry.Relation
Returns:
Type
olympe.dc.api.predicates.RelatedTo

getDestination()

Returns:
Type
string

getRecursive()

Returns:
Type
Array.<boolean>

getRelations()

Returns:
Type
Array.<!olympe.dc.registry.Relation>

observe(tag, index, callback)

Observe if any path with the proper relations exist

Parameters:
Name Type Description
tag string
index string
callback olympe.dc.api.Predicate.PredicateCallback
Implements:

serialize()

Serialize the predicate

Implements:
Returns:
Type
Object

toString()

Gets a string representation of this predicate

Implements:
Returns:

The string representation

Type
string