Relation¶

class Relation¶

Returned by

• RelationApi.CreateRelation

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:

A copy of this object

Return type:

Relation

GetSpecifiedTargetVersion()¶

Returns the version of relation target. This version is specified at the relation creation time and could be updated later.

Returns:

specified relation target version

Return type:

string

GetTargetPath()¶

Returns the path to the relation target.

Returns:

Path relative to the package directory

Return type:

string

GetType()¶

Returns the relation type.

Returns:

relation type e.g. ‘relatest to’ or ‘is derived from’

• RelationApi.RELATEST_TO

Return type:

int

IsSpecifiedVersionOutdated()¶

Returns true if the current version of relation target is not equal to already specified relation target version.

Returns:

True if the specified relation target version is outdated.

Return type:

boolean

SetSpecifiedTargetVersion(version)¶

Sets the version of relation target. The specified version is stored as a property of this relation.

Parameters:

version : string¶

The version of relation target to be set.

UpdateSpecifiedTargetVersion()¶

Updates the version of relation target to the current target value. This updated version is stored as a property of this relation.