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

Class VecTerminalRole

java.lang.Object
com.foursoft.harness.vec.v113.VecExtendableElement
com.foursoft.harness.vec.v113.VecRole
com.foursoft.harness.vec.v113.VecTerminalRole
All Implemented Interfaces:
Identifiable, ModifiableIdentifiable, HasCustomProperties<VecCustomProperty>, HasIdentification, HasModifiableIdentification, Visitable, Serializable
Direct Known Subclasses:
VecPluggableTerminalRole, VecRingTerminalRole, VecSpliceTerminalRole
public class VecTerminalRole extends VecRole implements Serializable, Visitable

A TerminalRole defines the instance specific properties and relationships of a terminal.

Java class for TerminalRole complex type.

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


 <complexType name="TerminalRole">
   <complexContent>
     <extension base="{http://www.prostep.org/ecad-if/2011/vec}Role">
       <sequence>
         <element name="SealState" type="{http://www.prostep.org/ecad-if/2011/vec}SealState" minOccurs="0"/>
         <element name="ComponentPort" type="{http://www.w3.org/2001/XMLSchema}IDREF" minOccurs="0"/>
         <element name="TerminalSpecification" type="{http://www.w3.org/2001/XMLSchema}IDREF"/>
         <element name="TerminalReceptionReference" type="{http://www.prostep.org/ecad-if/2011/vec}TerminalReceptionReference" maxOccurs="unbounded" minOccurs="0"/>
         <element name="WireReceptionReference" type="{http://www.prostep.org/ecad-if/2011/vec}WireReceptionReference" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • sealState

      protected String sealState

      Specifies if this instance of a terminal should be sealed (waterproof). This applies for example to SpliceTerminals.

    • componentPort

      protected VecComponentPort componentPort

    • terminalSpecification

      protected VecTerminalSpecification terminalSpecification

       References theTerminalSpecificationthat is instanced by thisTerminalRole.

    • terminalReceptionReferences

      protected List<VecTerminalReceptionReference> terminalReceptionReferences

      Specifies theTerminalReceptionReferencesof thisTerminalRole.

    • wireReceptionReferences

      protected List<VecWireReceptionReference> wireReceptionReferences

      Specifies theWireReceptionReferencesof thisTerminalRole.

  • Constructor Details

    • VecTerminalRole

      public VecTerminalRole()

  • Method Details

    • getSealState

      public String getSealState()
      Gets the value of the sealState property.

      Specifies if this instance of a terminal should be sealed (waterproof). This applies for example to SpliceTerminals.

      Returns:
      possible object is String

    • setSealState

      public void setSealState(String value)
      Sets the value of the sealState property.
      Parameters:
      value - allowed object is String
      See Also:

    • getComponentPort

      public VecComponentPort getComponentPort()
      Gets the value of the componentPort property.
      Returns:
      possible object is Object

    • setComponentPort

      public void setComponentPort(VecComponentPort value)
      Sets the value of the componentPort property.
      Parameters:
      value - allowed object is Object

    • getTerminalSpecification

      public VecTerminalSpecification getTerminalSpecification()
      Gets the value of the terminalSpecification property.

       References theTerminalSpecificationthat is instanced by thisTerminalRole.

      Returns:
      possible object is Object

    • setTerminalSpecification

      public void setTerminalSpecification(VecTerminalSpecification value)
      Sets the value of the terminalSpecification property.
      Parameters:
      value - allowed object is Object
      See Also:

    • getTerminalReceptionReferences

      public List<VecTerminalReceptionReference> getTerminalReceptionReferences()
      Gets the value of the terminalReceptionReferences 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 terminalReceptionReferences property.

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

          getTerminalReceptionReferences().add(newItem);

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

      Specifies theTerminalReceptionReferencesof thisTerminalRole.

      Returns:
      The value of the terminalReceptionReferences property.

    • getWireReceptionReferences

      public List<VecWireReceptionReference> getWireReceptionReferences()
      Gets the value of the wireReceptionReferences 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 wireReceptionReferences property.

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

          getWireReceptionReferences().add(newItem);

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

      Specifies theWireReceptionReferencesof thisTerminalRole.

      Returns:
      The value of the wireReceptionReferences property.

    • getRefContactPoint

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

    • getRefMatingPoint

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

    • getParentPinComponentReference

      public VecPinComponentReference getParentPinComponentReference()
      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 VecPinComponentReference 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