Module com.foursoft.harness.vec.v113
Package com.foursoft.harness.vec.v113

Class VecOccurrenceOrUsage

java.lang.Object
com.foursoft.harness.vec.v113.VecExtendableElement
com.foursoft.harness.vec.v113.VecConfigurableElement
com.foursoft.harness.vec.v113.VecOccurrenceOrUsage
All Implemented Interfaces:
Identifiable, ModifiableIdentifiable, HasCustomProperties<VecCustomProperty>, HasDescription<VecAbstractLocalizedString>, HasIdentification, HasModifiableIdentification, HasRoles<VecRole>, Visitable, Serializable
Direct Known Subclasses:
VecPartOccurrence, VecPartUsage
public abstract class VecOccurrenceOrUsage extends VecConfigurableElement implements Serializable, HasDescription<VecAbstractLocalizedString>, HasIdentification, HasModifiableIdentification, HasRoles<VecRole>, Visitable

An OccurrenceOrUsage is an abstract appearance of a part in the harness. This can either be a concrete part (with a part number a.s.o) or the description (specification / requirements) of a part that should be used at that position. In the first case it would be a PartOccurrence in the second case a PartUsage.

Java class for OccurrenceOrUsage complex type.

The following schema fragment specifies the expected content contained within this class. 


 <complexType name="OccurrenceOrUsage">
   <complexContent>
     <extension base="{http://www.prostep.org/ecad-if/2011/vec}ConfigurableElement">
       <sequence>
         <element name="Identification" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="AliasId" type="{http://www.prostep.org/ecad-if/2011/vec}AliasIdentification" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Abbreviation" type="{http://www.prostep.org/ecad-if/2011/vec}LocalizedString" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Description" type="{http://www.prostep.org/ecad-if/2011/vec}AbstractLocalizedString" maxOccurs="unbounded" minOccurs="0"/>
         <element name="RealizedUsageNode" type="{http://www.w3.org/2001/XMLSchema}IDREF" minOccurs="0"/>
         <element name="InstallationInstruction" type="{http://www.prostep.org/ecad-if/2011/vec}Instruction" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Role" type="{http://www.prostep.org/ecad-if/2011/vec}Role" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • identification

      protected String identification

      Specifies a unique identification of the OccurrenceOrUsage. The identification is guaranteed to be unique within the context. Over all VEC-documents an OccurrenceOrUsage-instance can be trusted to be the same if the context-instance is the same and the identification of the OccurrenceOrUsage is the same.

    • aliasIds

      protected List<VecAliasIdentification> aliasIds

      Room to specify additional identifiers for the OccurrenceOrUsage.

    • abbreviations

      protected List<VecLocalizedString> abbreviations

      Specifies an abbreviation of theOccurrenceOrUsage. Normally this a human readable short name.

    • descriptions

      protected List<VecAbstractLocalizedString> descriptions

      Specifies additional, human readable information about the OccurrenceOrUsage.

    • realizedUsageNode

      protected VecUsageNode realizedUsageNode

      References theUsageNodethat is realized by thisOccurrenceOrUsage.

    • installationInstructions

      protected List<VecInstruction> installationInstructions

    • roles

      protected List<VecRole> roles

      Specifies the different roles of the OccurrenceOrUsage.

  • Constructor Details

    • VecOccurrenceOrUsage

      public VecOccurrenceOrUsage()

  • Method Details

    • getIdentification

      public String getIdentification()
      Gets the value of the identification property.

      Specifies a unique identification of the OccurrenceOrUsage. The identification is guaranteed to be unique within the context. Over all VEC-documents an OccurrenceOrUsage-instance can be trusted to be the same if the context-instance is the same and the identification of the OccurrenceOrUsage is the same.

      Specified by:
      getIdentification in interface HasIdentification
      Returns:
      possible object is String

    • setIdentification

      public void setIdentification(String value)
      Sets the value of the identification property.
      Specified by:
      setIdentification in interface HasModifiableIdentification
      Parameters:
      value - allowed object is String
      See Also:

    • getAliasIds

      public List<VecAliasIdentification> getAliasIds()
      Gets the value of the aliasIds property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the aliasIds property.

      For example, to add a new item, do as follows: 

          getAliasIds().add(newItem);

      Objects of the following type(s) are allowed in the list VecAliasIdentification

      Room to specify additional identifiers for the OccurrenceOrUsage.

      Returns:
      The value of the aliasIds property.

    • getAbbreviations

      public List<VecLocalizedString> getAbbreviations()
      Gets the value of the abbreviations property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the abbreviations property.

      For example, to add a new item, do as follows: 

          getAbbreviations().add(newItem);

      Objects of the following type(s) are allowed in the list VecLocalizedString

      Specifies an abbreviation of theOccurrenceOrUsage. Normally this a human readable short name.

      Returns:
      The value of the abbreviations property.

    • getDescriptions

      public List<VecAbstractLocalizedString> getDescriptions()
      Gets the value of the descriptions property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the descriptions property.

      For example, to add a new item, do as follows: 

          getDescriptions().add(newItem);

      Objects of the following type(s) are allowed in the list VecAbstractLocalizedString

      Specifies additional, human readable information about the OccurrenceOrUsage.

      Specified by:
      getDescriptions in interface HasDescription<VecAbstractLocalizedString>
      Returns:
      The value of the descriptions property.

    • getRealizedUsageNode

      public VecUsageNode getRealizedUsageNode()
      Gets the value of the realizedUsageNode property.

      References theUsageNodethat is realized by thisOccurrenceOrUsage.

      Returns:
      possible object is Object

    • setRealizedUsageNode

      public void setRealizedUsageNode(VecUsageNode value)
      Sets the value of the realizedUsageNode property.
      Parameters:
      value - allowed object is Object
      See Also:

    • getInstallationInstructions

      public List<VecInstruction> getInstallationInstructions()
      Gets the value of the installationInstructions property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the installationInstructions property.

      For example, to add a new item, do as follows: 

          getInstallationInstructions().add(newItem);

      Objects of the following type(s) are allowed in the list VecInstruction

      Returns:
      The value of the installationInstructions property.

    • getRoles

      public List<VecRole> getRoles()
      Gets the value of the roles property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the roles property.

      For example, to add a new item, do as follows: 

          getRoles().add(newItem);

      Objects of the following type(s) are allowed in the list VecRole

      Specifies the different roles of the OccurrenceOrUsage.

      Specified by:
      getRoles in interface HasRoles<VecRole>
      Returns:
      The value of the roles property.

    • getRefOccurrenceOrUsageViewItem2D

      public Set<VecOccurrenceOrUsageViewItem2D> getRefOccurrenceOrUsageViewItem2D()
      Gets a Set of all VecOccurrenceOrUsageViewItem2D that have a outgoing reference to this object.
      Warning!: This is a readonly property! It has to be initialized during the unmarshalling process by the ExtendedUnmarshaller.
      This property is consistent to the state of object model at the time of unmarshalling. It does not reflect any changes done in the object model after the unmarshalling.
      This property has no effect when the object is marshalled to xml.

    • getRefOccurrenceOrUsageViewItem3D

      public Set<VecOccurrenceOrUsageViewItem3D> getRefOccurrenceOrUsageViewItem3D()
      Gets a Set of all VecOccurrenceOrUsageViewItem3D that have a outgoing reference to this object.
      Warning!: This is a readonly property! It has to be initialized during the unmarshalling process by the ExtendedUnmarshaller.
      This property is consistent to the state of object model at the time of unmarshalling. It does not reflect any changes done in the object model after the unmarshalling.
      This property has no effect when the object is marshalled to xml.

    • getRefPartWithSubComponentsRole

      public Set<VecPartWithSubComponentsRole> getRefPartWithSubComponentsRole()
      Gets a Set of all VecPartWithSubComponentsRole that have a outgoing reference to this object.
      Warning!: This is a readonly property! It has to be initialized during the unmarshalling process by the ExtendedUnmarshaller.
      This property is consistent to the state of object model at the time of unmarshalling. It does not reflect any changes done in the object model after the unmarshalling.
      This property has no effect when the object is marshalled to xml.