Package com.polarion.alm.tracker.variantmanagement

Interface IVariantManagementService

public interface IVariantManagementService

API covering various variant management related tasks. Deployed to HiveMind.

Since:

3.9.0

Author:

Roman Kratochvil, Polarion Software

Method Summary

Modifier and Type	Method	Description
IModule	generateSpecificationsForVariant(IModule sourceDocument, IWorkItem variant, ILocation targetLocation, String targetName)	Generates a specifications document for a specified variant from a source specifications document (i.
IVariantManagementConfiguration	getConfiguration()

Method Details

generateSpecificationsForVariant

@NotNull
IModule generateSpecificationsForVariant(@NotNull
 IModule sourceDocument,
 @NotNull
 IWorkItem variant,
 @NotNull
 ILocation targetLocation,
 @NotNull
 String targetName)

Generates a specifications document for a specified variant from a source specifications document (i. e. specification of all variants).
The output document is created by branching and filtering the source document.

Parameters:

sourceDocument - Initial specifications document

variant - Work Item of the concrete variant

targetLocation - Location (relative to documents root in project) of the resulting variant specifications document

targetName - Name of the resulting variant specifications document

Returns:

Resulting variant specifications document

getConfiguration

@NotNull
IVariantManagementConfiguration getConfiguration()

Returns:

the variant management configuration