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

Class VecSheetOrChapter

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

Documents can be structured into sheets or chapters. Since it is possible, that one document describes a couple of parts it is necessary to be able to specify which sheet or chapter contains the description of which part. (see KBLFRM-308)

Java class for SheetOrChapter complex type.

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


 <complexType name="SheetOrChapter">
   <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="SheetNumber" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SheetVersion" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Description" type="{http://www.prostep.org/ecad-if/2011/vec}AbstractLocalizedString" maxOccurs="unbounded" minOccurs="0"/>
         <element name="SheetFormat" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ReferencedPart" type="{http://www.w3.org/2001/XMLSchema}IDREFS" minOccurs="0"/>
         <element name="ChangeDescription" type="{http://www.prostep.org/ecad-if/2011/vec}ChangeDescription" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Specification" type="{http://www.prostep.org/ecad-if/2011/vec}Specification" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • identification

      protected String identification

      The identification of the sheet or chapter within the document. This value must be distinct within the context of a document.

    • sheetNumber

      protected String sheetNumber

      The sheetNumber is the major identifier of a SheetOrChapter. The format is user defined and respectively company specific. This field has to be used if a SheetOrChapter has its own "DocumentNumber".

    • sheetVersion

      protected String sheetVersion

      The sheetVersion specifies the version index of a sheet (see also sheetNumber)

    • descriptions

      protected List<VecAbstractLocalizedString> descriptions

      Room for additional, human readable information about the SheetOrChapter.

    • sheetFormat

      protected String sheetFormat

      Defines the format (e.g. size) of the SheetOrChapter.

    • referencedPart

      protected List<VecPartVersion> referencedPart

    • changeDescriptions

      protected List<VecChangeDescription> changeDescriptions

    • specifications

      protected List<VecSpecification> specifications

  • Constructor Details

    • VecSheetOrChapter

      public VecSheetOrChapter()

  • Method Details

    • getIdentification

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

      The identification of the sheet or chapter within the document. This value must be distinct within the context of a document.

      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:

    • getSheetNumber

      public String getSheetNumber()
      Gets the value of the sheetNumber property.

      The sheetNumber is the major identifier of a SheetOrChapter. The format is user defined and respectively company specific. This field has to be used if a SheetOrChapter has its own "DocumentNumber".

      Returns:
      possible object is String

    • setSheetNumber

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

    • getSheetVersion

      public String getSheetVersion()
      Gets the value of the sheetVersion property.

      The sheetVersion specifies the version index of a sheet (see also sheetNumber)

      Returns:
      possible object is String

    • setSheetVersion

      public void setSheetVersion(String value)
      Sets the value of the sheetVersion property.
      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

      Room for additional, human readable information about the SheetOrChapter.

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

    • getSheetFormat

      public String getSheetFormat()
      Gets the value of the sheetFormat property.

      Defines the format (e.g. size) of the SheetOrChapter.

      Returns:
      possible object is String

    • setSheetFormat

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

    • getChangeDescriptions

      public List<VecChangeDescription> getChangeDescriptions()
      Gets the value of the changeDescriptions 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 changeDescriptions property.

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

          getChangeDescriptions().add(newItem);

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

      Returns:
      The value of the changeDescriptions property.

    • getSpecifications

      public List<VecSpecification> getSpecifications()
      Gets the value of the specifications 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 specifications property.

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

          getSpecifications().add(newItem);

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

      Specified by:
      getSpecifications in interface HasSpecifications<VecSpecification>
      Returns:
      The value of the specifications property.

    • getRefDocumentBasedInstruction

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

    • getReferencedPart

      public List<VecPartVersion> getReferencedPart()
      Gets the value of the referencedPart 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 referencedPart property.

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

          getReferencedPart().add(newItem);

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

    • getParentDocumentVersion

      public VecDocumentVersion getParentDocumentVersion()
      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 VecDocumentVersion 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