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

Class VecHousingComponent

java.lang.Object
com.foursoft.harness.vec.v113.VecExtendableElement
com.foursoft.harness.vec.v113.VecHousingComponent
All Implemented Interfaces:
Identifiable, ModifiableIdentifiable, HasCustomProperties<VecCustomProperty>, HasDescription<VecAbstractLocalizedString>, HasIdentification, HasModifiableIdentification, Visitable, Serializable
public class VecHousingComponent extends VecExtendableElement implements Serializable, HasDescription<VecAbstractLocalizedString>, HasIdentification, HasModifiableIdentification, Visitable

A HousingComponent describes the interface of an EEComponent with which it can be connected to another EEComponent or a harness. The characteristics of the interface can be described with a referenced ConnectorHousingSpecification. (see KBLFRM-300)

Java class for HousingComponent complex type.

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


 <complexType name="HousingComponent">
   <complexContent>
     <extension base="{http://www.prostep.org/ecad-if/2011/vec}ExtendableElement">
       <sequence>
         <element name="Identification" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="Description" type="{http://www.prostep.org/ecad-if/2011/vec}AbstractLocalizedString" maxOccurs="unbounded" minOccurs="0"/>
         <element name="HousingSpecification" type="{http://www.w3.org/2001/XMLSchema}IDREF" minOccurs="0"/>
         <element name="PinComponent" type="{http://www.prostep.org/ecad-if/2011/vec}PinComponent" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • identification

      protected String identification

      Identification of the HousingComponent, which must be distinct for all HousingComponents of an EEComponent.

    • descriptions

      protected List<VecAbstractLocalizedString> descriptions

      Specifies additional, human readable information about theHousingComponent.

    • housingSpecification

      protected VecConnectorHousingSpecification housingSpecification

    • pinComponents

      protected List<VecPinComponent> pinComponents

  • Constructor Details

    • VecHousingComponent

      public VecHousingComponent()

  • Method Details

    • getIdentification

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

      Identification of the HousingComponent, which must be distinct for all HousingComponents of an EEComponent.

      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:

    • 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 theHousingComponent.

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

    • getHousingSpecification

      public VecConnectorHousingSpecification getHousingSpecification()
      Gets the value of the housingSpecification property.
      Returns:
      possible object is Object

    • setHousingSpecification

      public void setHousingSpecification(VecConnectorHousingSpecification value)
      Sets the value of the housingSpecification property.
      Parameters:
      value - allowed object is Object

    • getPinComponents

      public List<VecPinComponent> getPinComponents()
      Gets the value of the pinComponents 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 pinComponents property.

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

          getPinComponents().add(newItem);

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

      Returns:
      The value of the pinComponents property.

    • getRefHousingComponentReference

      public Set<VecHousingComponentReference> getRefHousingComponentReference()
      Gets a Set of all VecHousingComponentReference 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.

    • getParentEEComponentSpecification

      public VecEEComponentSpecification getParentEEComponentSpecification()
      Gets a reference to the parent of this object in the XML DOM Tree. If this class can have different parents in DOM, this property is initialized with the parent, if the parent is a VecEEComponentSpecification otherwise it will be null.
      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.

    • accept

      public <R, E extends Throwable> R accept(Visitor<R,E> aVisitor) throws E
      Specified by:
      accept in interface Visitable
      Throws:
      E extends Throwable