Interface InstanceModel
-
- All Superinterfaces:
BaseModel
,java.lang.Cloneable
- All Known Implementing Classes:
InstanceModelImpl
public interface InstanceModel extends BaseModel
Represents the instance value model.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
GENERAL_GROUP_NAME
General group, used for all cstic, which are not assigned to another group
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
addCstic(CsticModel cstic)
CsticModel
getCstic(java.lang.String csticName)
java.util.List<CsticGroupModel>
getCsticGroups()
java.util.List<CsticModel>
getCstics()
java.lang.String
getId()
java.lang.String
getLanguageDependentName()
java.lang.String
getName()
java.lang.String
getPosition()
InstanceModel
getSubInstance(java.lang.String subInstanceId)
java.util.List<InstanceModel>
getSubInstances()
default java.util.List<VariantConditionModel>
getVariantConditions()
boolean
isComplete()
boolean
isConsistent()
boolean
isRootInstance()
boolean
removeCstic(CsticModel cstic)
InstanceModel
removeSubInstance(java.lang.String subInstanceId)
removes the subinstance from the subinstance list for the given subinstance idjava.util.List<CsticGroup>
retrieveCsticGroupsWithCstics()
void
setComplete(boolean complete)
void
setConsistent(boolean consistent)
void
setCsticGroups(java.util.List<CsticGroupModel> csticGroups)
void
setCstics(java.util.List<CsticModel> cstic)
void
setId(java.lang.String id)
void
setLanguageDependentName(java.lang.String languageDependentName)
void
setName(java.lang.String name)
void
setPosition(java.lang.String position)
void
setRootInstance(boolean rootInstance)
void
setSubInstance(InstanceModel subInstance)
void
setSubInstances(java.util.List<InstanceModel> subInstances)
default void
setVariantConditions(java.util.List<VariantConditionModel> variantConditions)
-
-
-
Field Detail
-
GENERAL_GROUP_NAME
static final java.lang.String GENERAL_GROUP_NAME
General group, used for all cstic, which are not assigned to another group- See Also:
- Constant Field Values
-
-
Method Detail
-
getId
java.lang.String getId()
- Returns:
- the instance id
-
setId
void setId(java.lang.String id)
- Parameters:
id
- instance id
-
getName
java.lang.String getName()
- Returns:
- the instance name
-
setName
void setName(java.lang.String name)
- Parameters:
name
- instance name
-
getLanguageDependentName
java.lang.String getLanguageDependentName()
- Returns:
- the instance language dependent name
-
setLanguageDependentName
void setLanguageDependentName(java.lang.String languageDependentName)
- Parameters:
languageDependentName
- instance language dependent name
-
getCstic
CsticModel getCstic(java.lang.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
java.util.List<CsticModel> getCstics()
- Returns:
- unmodifiable list of characteristic models of this instance, to add/remove cstics, use manipulators of this interface
-
setCstics
void setCstics(java.util.List<CsticModel> cstic)
- Parameters:
cstic
- list of characteristic models
-
getSubInstance
InstanceModel getSubInstance(java.lang.String subInstanceId)
- Parameters:
subInstanceId
- subinstance id- Returns:
- the subinstance model for the given subinstance id
-
removeSubInstance
InstanceModel removeSubInstance(java.lang.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
java.util.List<InstanceModel> getSubInstances()
- Returns:
- the list of subinstance models of this instance
-
setSubInstances
void setSubInstances(java.util.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(java.util.List<CsticGroupModel> csticGroups)
- Parameters:
csticGroups
- list of characteristic group models
-
getCsticGroups
java.util.List<CsticGroupModel> getCsticGroups()
- Returns:
- the list of characteristic group models from this instance
-
retrieveCsticGroupsWithCstics
java.util.List<CsticGroup> retrieveCsticGroupsWithCstics()
- Returns:
- the list of
CsticGroup
from this instance
-
getPosition
java.lang.String getPosition()
- Returns:
- the BOM position of this instance
-
setPosition
void setPosition(java.lang.String position)
- Parameters:
position
- BOM position of this instance
-
getVariantConditions
default java.util.List<VariantConditionModel> getVariantConditions()
- Returns:
- list of variant conditions
-
setVariantConditions
default void setVariantConditions(java.util.List<VariantConditionModel> variantConditions)
- Parameters:
variantConditions
- variant conditions for the configuration
-
-