All Superinterfaces:
BaseModel, Cloneable
All Known Implementing Classes:
InstanceModelImpl

public interface InstanceModel extends BaseModel
Represents the instance value model.
  • Field Details

    • GENERAL_GROUP_NAME

      static final String GENERAL_GROUP_NAME
      General group, used for all cstic, which are not assigned to another group
      See Also:
  • Method Details

    • getId

      String getId()
      Returns:
      the instance id
    • setId

      void setId(String id)
      Parameters:
      id - instance id
    • getName

      String getName()
      Returns:
      the instance name
    • setName

      void setName(String name)
      Parameters:
      name - instance name
    • getLanguageDependentName

      String getLanguageDependentName()
      Returns:
      the instance language dependent name
    • setLanguageDependentName

      void setLanguageDependentName(String languageDependentName)
      Parameters:
      languageDependentName - instance language dependent name
    • getCstic

      CsticModel getCstic(String csticName)
      Parameters:
      csticName - characteristic name
      Returns:
      the characteristic model for the given characteristic name
    • addCstic

      void addCstic(CsticModel cstic)
      Parameters:
      cstic - characteristic model
    • removeCstic

      boolean removeCstic(CsticModel cstic)
      Parameters:
      cstic - characteristic model
      Returns:
      true if the cstics was part of the list
    • getCstics

      List<CsticModel> getCstics()
      Returns:
      unmodifiable list of characteristic models of this instance, to add/remove cstics, use manipulators of this interface
    • setCstics

      void setCstics(List<CsticModel> cstic)
      Parameters:
      cstic - list of characteristic models
    • getSubInstance

      InstanceModel getSubInstance(String subInstanceId)
      Parameters:
      subInstanceId - subinstance id
      Returns:
      the subinstance model for the given subinstance id
    • removeSubInstance

      InstanceModel removeSubInstance(String subInstanceId)
      removes the subinstance from the subinstance list for the given subinstance id
      Parameters:
      subInstanceId - subinstance id
      Returns:
      removed subinstance model
    • setSubInstance

      void setSubInstance(InstanceModel subInstance)
      Parameters:
      subInstance - subinstance model
    • getSubInstances

      List<InstanceModel> getSubInstances()
      Returns:
      the list of subinstance models of this instance
    • setSubInstances

      void setSubInstances(List<InstanceModel> subInstances)
      Parameters:
      subInstances - list of subinstance models
    • isConsistent

      boolean isConsistent()
      Returns:
      true if this instance is consistent
    • setConsistent

      void setConsistent(boolean consistent)
      Parameters:
      consistent - flag indicating whether this instance is consistent
    • isComplete

      boolean isComplete()
      Returns:
      true if this instance is complete
    • setComplete

      void setComplete(boolean complete)
      Parameters:
      complete - flag indicating whether this instance is complete
    • isRootInstance

      boolean isRootInstance()
      Returns:
      true if this instance is a root instance
    • setRootInstance

      void setRootInstance(boolean rootInstance)
      Parameters:
      rootInstance - flag indicating whether this instance is a root instance
    • setCsticGroups

      void setCsticGroups(List<CsticGroupModel> csticGroups)
      Parameters:
      csticGroups - list of characteristic group models
    • getCsticGroups

      List<CsticGroupModel> getCsticGroups()
      Returns:
      the list of characteristic group models from this instance
    • retrieveCsticGroupsWithCstics

      List<CsticGroup> retrieveCsticGroupsWithCstics()
      Returns:
      the list of CsticGroup from this instance
    • getPosition

      String getPosition()
      Returns:
      the BOM position of this instance
    • setPosition

      void setPosition(String position)
      Parameters:
      position - BOM position of this instance
    • getVariantConditions

      default List<VariantConditionModel> getVariantConditions()
      Returns:
      list of variant conditions
    • setVariantConditions

      default void setVariantConditions(List<VariantConditionModel> variantConditions)
      Parameters:
      variantConditions - variant conditions for the configuration