VariantFinder

All Known Implementing Classes:: DefaultVariantFinder

public interface VariantFinder

Finds variants based on a Model.

Supported API: true

Extendable: true

Method Summary

Modifier and Type

Method

Description

void

find(Model model)

Find variants that match this variant specification.

Map<String,VariantFinderResult[]>

getMatchingVariantMap(Model model)

Find variants that match this variant specification.

String

getVariantOid(Model model)

Find the variant that matched this model.

Method Details
- find
  
  void find(Model model) throws WTException
  
  Find variants that match this variant specification.
  
  Supported API: true
  
  Parameters:
  
  model - solution model for the VariantSpec
  
  Throws:
  
  WTException
- getVariantOid
  
  String getVariantOid(Model model) throws WTException
  
  Find the variant that matched this model.
  
  Supported API: true
  
  Parameters:
  
  model - the solution model
  
  Returns:
  
  the object id String of the variant part or null
  
  Throws:
  
  WTException
- getMatchingVariantMap
  
  Map<String,VariantFinderResult[]> getMatchingVariantMap(Model model) throws WTException
  
  Find variants that match this variant specification.
  
  Supported API: true
  
  Parameters:
  
  model - solution model for the VariantSpec
  
  Returns:
  
  Map of String to VariantFinderResult []. The key of part number will be mapped to an array of VariantFinderResult objects, one VariantFinderResult for each version that matches.
  
  Throws:
  
  Exception
  
  WTException