Package com.ptc.wpcfg.engine2.model

Interface Model

All Superinterfaces:
com.ptc.wpcfg.appdata.AppDataHolder, Cloneable, com.ptc.wpcfg.engine2.model.ModelElement, com.ptc.wpcfg.engine2.model.value.MutableValueHolder, com.ptc.wpcfg.engine2.model.ParameterSet, Serializable, com.ptc.wpcfg.engine2.model.value.ValueHolder
public interface Model extends com.ptc.wpcfg.engine2.model.ModelElement, com.ptc.wpcfg.engine2.model.ParameterSet
Model is tree-like container of ModelParameter (Composite pattern).

Supported API: true

Extendable: false
See Also:

  • Field Summary

    Fields inherited from interface com.ptc.wpcfg.appdata.AppDataHolder

    TRANSIENT_DATA

  • Method Summary

    Modifier and Type
    Method
    Description
    Enumeration
    getChildModels(boolean onlyIncludedOrUndefined)


    Supported API: true
    String
    getComponentId()


    Supported API: true
    String
    getIteration()


    Supported API: true
    Integer
    getMaxAllowedChildren()


    Supported API: true Returns the maximum allowed number of children defined for the corresponding part.
    Integer
    getMinRequiredChildren()


    Supported API: true Returns the minimum required number of children defined for the corresponding part.
    Enumeration
    getModelParameters()


    Supported API: true
    String
    getName()


    Supported API: true
    String
    getNumber()


    Supported API: true
    Map<String,Collection<ModelOccurrenceBean>>
    getOccurrenceMap()


    Supported API: true Returns the map between usage link component id and a collection of its occurrence beans.
    String
    getOid()


    Supported API: true
    Model
    getVariant()


    Supported API: true Returns the variant.
    String
    getVersion()


    Supported API: true
    boolean
    hasIdenticalInputs(Model otherModel)
    Compares values of the input parameters in this model structure with those in the other model.

    Methods inherited from interface com.ptc.wpcfg.appdata.AppDataHolder

    getAppData, getCompactAppData

    Methods inherited from interface com.ptc.wpcfg.engine2.model.ModelElement

    changeParent, getFQName, getParent, isIdentical, setParent

    Methods inherited from interface com.ptc.wpcfg.engine2.model.value.MutableValueHolder

    clearValue, setValue

    Methods inherited from interface com.ptc.wpcfg.engine2.model.value.ValueHolder

    getValue, hasValue

  • Method Details

    • getOid

      String getOid()


      Supported API: true
      Returns:
      Model object id (persistable OID)

    • getName

      String getName()


      Supported API: true
      Specified by:
      getName in interface com.ptc.wpcfg.engine2.model.ModelElement
      Returns:
      Model name (human readable)

    • getNumber

      String getNumber()


      Supported API: true
      Returns:
      Model number (system unique)

    • getVersion

      String getVersion()


      Supported API: true
      Returns:
      the model version id.

    • getIteration

      String getIteration()


      Supported API: true
      Returns:
      the model iteration id.

    • getComponentId

      String getComponentId()


      Supported API: true
      Returns:
      component Id of this model in context of parent Model (fully instanced)

    • getModelParameters

      Enumeration getModelParameters()


      Supported API: true
      Specified by:
      getModelParameters in interface com.ptc.wpcfg.engine2.model.ParameterSet
      Returns:
      Enumeration of ModelParameters on this level.
      See Also:

    • getChildModels

      Enumeration getChildModels(boolean onlyIncludedOrUndefined)


      Supported API: true
      Parameters:
      onlyIncludedOrUndefined - if true result will contain included or undefined
      Returns:
      Enumeration of child Models for this node.

    • getVariant

      Model getVariant()


      Supported API: true Returns the variant.
      Returns:
      "variant" model - model that already exists in DB and "identical" to this one

    • hasIdenticalInputs

      boolean hasIdenticalInputs(Model otherModel)
      Compares values of the input parameters in this model structure with those in the other model.

      Supported API: true
      Parameters:
      otherModel - the other model to compare against.
      Returns:
      true, if all the values of all input parameters match.

    • getMinRequiredChildren

      Integer getMinRequiredChildren()


      Supported API: true Returns the minimum required number of children defined for the corresponding part.
      Returns:
      the minimum required number of children.

    • getMaxAllowedChildren

      Integer getMaxAllowedChildren()


      Supported API: true Returns the maximum allowed number of children defined for the corresponding part.
      Returns:
      the maximum allowed number of children.

    • getOccurrenceMap

      Map<String,Collection<ModelOccurrenceBean>> getOccurrenceMap()


      Supported API: true Returns the map between usage link component id and a collection of its occurrence beans.
      Returns:
      a map of component id to occurrence beans