Change¶

class Change¶

Represents a change between an old element and a new element. Both elements have the same type, e.g. a certain test step and stem from two different Objects, e.g. an old Package a new Package.

Returned by

• ConfigurationApi.GetChangesForTestBenchConfigurations

• ConfigurationApi.GetChangesForTestConfigurations

• GlobalMappingApi.GetChanges

• PackageApi.GetAnalysisPackageChanges

• PackageApi.GetChanges

• ParameterApi.GetChangesForGlobalConstantsDefinitions

• ParameterApi.GetChangesForPackageParametersDefinitions

• ProjectApi.GetChanges

• TestStepApi.GetChanges

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:

Change

GetComparedProperties()¶

Return the properties based on which the old element and the new element were compared.

Returns:

A list of names of compared properties.

Return type:

list[str]

GetNewPath()¶

Returns the path to the new element, e.g. ‘0:Package/2:Testcase/0:Block 1/5:Comment 3’.

Returns:

The path to the new element.

Return type:

str

GetOldPath()¶

Returns the path to the old element, e.g. ‘0:Package/2:Testcase/0:Block 1/5:Comment 3’.

Returns:

The path to the old element.

Return type:

str

GetType()¶

Returns the type of action that is associated with this change. The action type can be one of the following:

• INSERT - The new element was inserted.

• DELETE - The old element was deleted.

• MOVE - The new element was moved with respect to the old one.

• UPDATE - The new element differs in certain values with respect to the old one.

• POTENTIALUPDATE - The elements can’t be compared completely. There may exist a change.

Returns:

The type of action that is associated with this change.

Return type:

str

GetValueDifferences()¶

Returns a list with differences that exist between values of the old and the new element.

Returns:

A list of changed values.

Return type:

list[ValueDifference]