Package com.ptc.wpcfg.doc

Class VariantSpec

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.enterprise._RevisionControlled
wt.enterprise.RevisionControlled
com.ptc.wpcfg.doc._VariantSpec
com.ptc.wpcfg.doc.VariantSpec
All Implemented Interfaces:
com.ptc.wpcfg.doc._VariantSpecTypeInterface, com.ptc.wpcfg.doc.VariantSpecTypeInterface, Externalizable, Serializable, wt.access._AccessControlled, wt.access._AccessControlList, wt.access._AdHocControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.AccessControlList, AdHocControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.change2._Changeable2, wt.change2._ChangeableIfc, Changeable2, ChangeableIfc, wt.content._ContentHolder, wt.content._FormatContentHolder, ContentHolder, FormatContentHolder, wt.esi._Datable, wt.esi._Releasable, Datable, Releasable, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, wt.fc.archive._Archiveable, wt.fc.archive.Archiveable, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, wt.federation._FederatedLinkHolder, wt.federation._RemotelyLinkable, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, wt.folder._CabinetBased, wt.folder._Foldered, wt.folder._FolderEntry, wt.folder._FolderServiceManaged, wt.folder._IteratedFoldered, CabinetBased, Foldered, FolderEntry, wt.folder.FolderServiceManaged, IteratedFoldered, wt.iba.value._IBAHolder, wt.iba.value.IBAHolder, DisplayIdentification, wt.index._Indexable, Indexable, wt.inf.container._WTContained, WTContained, wt.lifecycle._IteratedLifeCycleManaged, _LifeCycleManaged, IteratedLifeCycleManaged, LifeCycleManaged, wt.locks._Lockable, Lockable, wt.maturity._Promotable, Promotable, wt.meeting.actionitem._IteratedSubjectOfActionItem, wt.meeting.actionitem._SubjectOfActionItem, wt.meeting.actionitem.IteratedSubjectOfActionItem, wt.meeting.actionitem.SubjectOfActionItem, wt.notify._Notifiable, Notifiable, wt.option._ModuleVariantInformationContext, ModuleVariantInformationContext, _OrganizationOwned, wt.org._OrganizationOwnedVersion, OrganizationOwned, OrganizationOwnedVersion, wt.ownership._Ownable, wt.ownership.Ownable, wt.productfamily._ProductFamilyMemberIfc, wt.productfamily.ProductFamilyMemberIfc, wt.projmgmt.deliverable._SubjectOfDeliverable, wt.projmgmt.deliverable._VersionedSubjectOfDeliverable, wt.projmgmt.deliverable.SubjectOfDeliverable, wt.projmgmt.deliverable.VersionedSubjectOfDeliverable, wt.recent.RecentlyVisited, wt.sandbox._Interoperable, wt.sandbox.Interoperable, _TeamManaged, TeamManaged, wt.type._Typed, wt.type._TypeManaged, wt.type.FlexTyped, wt.type.Typed, wt.type.TypeManaged, wt.ufid._Federatable, wt.ufid.Federatable, _Iterated, wt.vc._OneOffVersioned, wt.vc._Versionable, wt.vc._Versioned, wt.vc.baseline._Baselineable, Baselineable, Iterated, OneOffVersioned, Versionable, Versioned, wt.vc.wip._Workable, Workable, wt.workflow.forum._IteratedSubjectOfForum, wt.workflow.forum._SubjectOfForum, wt.workflow.forum.IteratedSubjectOfForum, SubjectOfForum, wt.workflow.notebook._IteratedSubjectOfNotebook, wt.workflow.notebook._SubjectOfNotebook, wt.workflow.notebook.IteratedSubjectOfNotebook, wt.workflow.notebook.SubjectOfNotebook
@GenAsPersistable(superClass=RevisionControlled.class,interfaces={wt.iba.value.IBAHolder.class,WTContained.class,wt.ufid.Federatable.class,FormatContentHolder.class,wt.type.Typed.class,wt.fc.archive.Archiveable.class,OrganizationOwnedVersion.class,OneOffVersioned.class,wt.sandbox.Interoperable.class,com.ptc.wpcfg.doc.VariantSpecTypeInterface.class,wt.productfamily.ProductFamilyMemberIfc.class,wt.projmgmt.deliverable.VersionedSubjectOfDeliverable.class,Datable.class,ModuleVariantInformationContext.class,Releasable.class},versions={2437200917848557231L,4029543429321180234L},properties={@GeneratedProperty(name="complete",type=boolean.class,javaDoc="If true variant spec is complete - all persistent parameters have values. This attribute must be in sync with XML content. (See attribute wpcfamily.isresolved)"),@GeneratedProperty(name="sessionid",type=long.class,javaDoc="Reserved for Spec Editor session. Internal use only."),@GeneratedProperty(name="description",type=java.lang.String.class,supportedAPI=PUBLIC,constraints=@PropertyConstraints(upperLimit=2000)),@GeneratedProperty(name="basedOnDefaultBaseline",type=boolean.class,javaDoc="Attribute that indicates that the configSpec reference of this VariantSpec is a default baseline configSpec or not."),@GeneratedProperty(name="managedAs",type=com.ptc.wpcfg.doc.VariantSpecManagedType.class,initialValue="VariantSpecManagedType.STANDALONE",constraints=@PropertyConstraints(required=true,upperLimit=40),columnProperties=@ColumnProperties(defaultValue="standalone"),javaDoc="Management type used for this VariantSpec version.")},foreignKeys={@GeneratedForeignKey(myRoleIsRoleA=false,foreignKeyRole=@ForeignKeyRole(name="genericizable",type=Genericizable.class),myRole=@MyRole(name="variantSpec")),@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="master",type=com.ptc.wpcfg.doc.VariantSpecMaster.class,cascade=false,constraints=@PropertyConstraints(required=true),accessors=@PropertyAccessors(getAccess=PRIVATE)),myRole=@MyRole(name="iteration",cascade=false,accessors=@PropertyAccessors(getAccess=PRIVATE,setAccess=PROTECTED))),@GeneratedForeignKey(name="VariantSpecConfigSpecLink",myRoleIsRoleA=false,foreignKeyRole=@ForeignKeyRole(name="configSpec",type=wt.vc.config.PersistableConfigSpec.class,constraints=@PropertyConstraints(required=false)),myRole=@MyRole(name="variantSpec",cardinality=ZERO_TO_ONE)),@GeneratedForeignKey(myRoleIsRoleA=true,foreignKeyRole=@ForeignKeyRole(name="navigationCriteria",type=NavigationCriteria.class,constraints=@PropertyConstraints(required=false)),myRole=@MyRole(name="variantSpec",cardinality=ZERO_TO_ONE)),@GeneratedForeignKey(myRoleIsRoleA=false,foreignKeyRole=@ForeignKeyRole(name="releasedConfigurationBaseline",type=Baseline.class,constraints=@PropertyConstraints(required=false)),myRole=@MyRole(name="variantSpec"))},derivedProperties={@DerivedProperty(name="name",derivedFrom="master>name",supportedAPI=PUBLIC),@DerivedProperty(name="number",derivedFrom="master>number",supportedAPI=PUBLIC)},tableProperties=@TableProperties(compositeIndex10="iterationInfo.latest",compositeIndex11="thePersistInfo.markForDelete",compositeIndex12="genericizableReference.key.id",compositeIndex17="releasedConfigurationBaselineReference.key.id",compositeUnique1="+oneOffVersionInfo.identifier.oneOffVersionId"),iconProperties=@IconProperties(standardIcon="wt/clients/images/variantspec.gif",openIcon="wt/clients/images/variantspec.gif")) public class VariantSpec extends _VariantSpec
Variant specification stores output of Order Generator (values for all model parameter) as XML file.

Use the newVariantSpec static factory method(s), not the VariantSpec constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:

  • Method Details

    • getName

      public String getName()
      Gets the value of the attribute: NAME.

      Supported API: true
      Specified by:
      getName in interface CabinetBased
      Specified by:
      getName in interface wt.projmgmt.deliverable.SubjectOfDeliverable
      Overrides:
      getName in class _VariantSpec
      Returns:
      String
      See Also:

    • setName

      public void setName(String a_Name) throws WTPropertyVetoException
      Sets the value of the attribute: NAME.

      Supported API: true
      Overrides:
      setName in class _VariantSpec
      Parameters:
      a_Name -
      Throws:
      WTPropertyVetoException
      See Also:

    • getNumber

      public String getNumber()
      Gets the value of the attribute: NUMBER.

      Supported API: true
      Overrides:
      getNumber in class _VariantSpec
      Returns:
      String
      See Also:

    • setNumber

      public void setNumber(String a_Number) throws WTPropertyVetoException
      Sets the value of the attribute: NUMBER.

      Supported API: true
      Overrides:
      setNumber in class _VariantSpec
      Parameters:
      a_Number -
      Throws:
      WTPropertyVetoException
      See Also:

    • getOrganization

      public WTOrganization getOrganization()
      Gets the value of the attribute: ORGANIZATION.

      Supported API: true
      Returns:
      WTOrganization

    • isStandalone

      public boolean isStandalone()
      Returns true for a standalone VariantSpec.

      Supported API: true

    • isProductFamilyOrganized

      public boolean isProductFamilyOrganized()
      Returns true for a product family organized VariantSpec.

      Supported API: true

    • isProductFamilyManaged

      public boolean isProductFamilyManaged()
      Returns true for product family managed VariantSpec.

      Supported API: true