API for Relations

Part of the Object based program API.

class RelationApi

API to access relations

Returned by

IMPLEMENTS

Returns the constant used to specify the relation type ‘implements’:

Returns:

‘implements’ constant

Return type:

int

IS_DERIVED_FROM

Returns the constant used to specify the relation type ‘is derived from’:

Returns:

‘is derived from’ constant

Return type:

int

RELATES_TO

Returns the constant used to specify the relation type ‘relates to’:

Returns:

‘relates to’ constant

Return type:

int

CreateRelation(relationType, packagePath)

Creates a new relation with the current target version.

Parameters:
relationType : int

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

  • RelationApi.RELATEST_TO

packagePath : str

Path to Package

Returns:

new Relation

Return type:

Relation