Package eu.europa.data.europass.model.credentials_

Class DocumentType

  • All Implemented Interfaces:
    com.helger.commons.lang.IExplicitlyCloneable, Cloneable
    @CodingStyleguideUnaware
public class DocumentType
extends Object
implements com.helger.commons.lang.IExplicitlyCloneable
    A public accessible web document.

    Java class for DocumentType complex type.

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

     <complexType name="DocumentType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="title" type="{http://data.europa.eu/europass/model/credentials#}LanguageStringType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="language" maxOccurs="unbounded" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://data.europa.eu/europass/model/credentials#}CodeType">
                 <sequence>
                   <element name="targetName" type="{http://data.europa.eu/europass/model/credentials#}LanguageStringType" maxOccurs="unbounded"/>
                   <element name="targetDescription" type="{http://data.europa.eu/europass/model/credentials#}NoteType" maxOccurs="unbounded" minOccurs="0"/>
                   <element name="targetFrameworkName" type="{http://data.europa.eu/europass/model/credentials#}LanguageStringType" maxOccurs="unbounded"/>
                 </sequence>
                 <attribute name="uri" type="{http://data.europa.eu/europass/model/credentials#}LanguageEnumType" />
                 <attribute name="targetID" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
                 <attribute name="type" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
                 <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}normalizedString" />
                 <attribute name="targetNotation" type="{http://www.w3.org/2001/XMLSchema}token" />
                 <attribute name="targetFrameworkID" type="{http://data.europa.eu/europass/model/credentials#}IdType" />
                 <attribute name="targetFrameworkUrl" use="required" type="{http://data.europa.eu/europass/model/credentials#}DocumentURLType" />
                 <attribute name="targetFrameworkSpatialID" type="{http://data.europa.eu/europass/model/credentials#}LocationCodeContentType" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="subject" maxOccurs="unbounded" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://data.europa.eu/europass/model/credentials#}CodeType">
                 <sequence>
                   <element name="targetName" type="{http://data.europa.eu/europass/model/credentials#}LanguageStringType" maxOccurs="unbounded"/>
                   <element name="targetDescription" type="{http://data.europa.eu/europass/model/credentials#}NoteType" maxOccurs="unbounded" minOccurs="0"/>
                   <element name="targetFrameworkName" type="{http://data.europa.eu/europass/model/credentials#}LanguageStringType" maxOccurs="unbounded"/>
                 </sequence>
                 <attribute name="uri" type="{http://data.europa.eu/europass/model/credentials#}SubjectTypeCodeEnumType" />
                 <attribute name="targetID" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
                 <attribute name="type" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
                 <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}normalizedString" />
                 <attribute name="targetNotation" type="{http://www.w3.org/2001/XMLSchema}token" />
                 <attribute name="targetFrameworkID" type="{http://data.europa.eu/europass/model/credentials#}IdType" />
                 <attribute name="targetFrameworkUrl" use="required" type="{http://data.europa.eu/europass/model/credentials#}DocumentURLType" />
                 <attribute name="targetFrameworkSpatialID" type="{http://data.europa.eu/europass/model/credentials#}LocationCodeContentType" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
       </sequence>
       <attribute name="uri" use="required" type="{http://data.europa.eu/europass/model/credentials#}DocumentURLType" />
     </restriction>
   </complexContent>
 </complexType>

    This class was annotated by ph-jaxb22-plugin -Xph-annotate

    This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode

    This class contains methods created by ph-jaxb22-plugin -Xph-tostring

    This class contains methods created by ph-jaxb22-plugin -Xph-list-extension

    This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2

    This class contains methods created by ph-jaxb22-plugin -Xph-value-extender

    • Constructor Detail

      • DocumentType

        public DocumentType()
        Default constructor
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

    • Method Detail

      • getTitle

        @Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List<LanguageStringType> getTitle()
        Gets the value of the title 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 JAXB object. This is why there is not a set method for the title property.

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

            getTitle().add(newItem);

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

      • getLanguage

        @Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List<DocumentType.Language> getLanguage()
        Gets the value of the language 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 JAXB object. This is why there is not a set method for the language property.

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

            getLanguage().add(newItem);

        Objects of the following type(s) are allowed in the list DocumentType.Language

      • getSubject

        @Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List<DocumentType.Subject> getSubject()
        Gets the value of the subject 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 JAXB object. This is why there is not a set method for the subject property.

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

            getSubject().add(newItem);

        Objects of the following type(s) are allowed in the list DocumentType.Subject

      • getUri

        @Nullable
public String getUri()
        Gets the value of the uri property.
        Returns:
        possible object is String

      • setUri

        public void setUri​(@Nullable
                   String value)
        Sets the value of the uri property.
        Parameters:
        value - allowed object is String

      • equals

        public boolean equals​(Object o)
        Created by ph-jaxb22-plugin -Xph-equalshashcode
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Created by ph-jaxb22-plugin -Xph-equalshashcode
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Created by ph-jaxb22-plugin -Xph-tostring
        Overrides:
        toString in class Object

      • setTitle

        public void setTitle​(@Nullable
                     List<LanguageStringType> aList)
        Created by ph-jaxb22-plugin -Xph-list-extension
        Parameters:
        aList - The new list member to set. May be null.

      • setLanguage

        public void setLanguage​(@Nullable
                        List<DocumentType.Language> aList)
        Created by ph-jaxb22-plugin -Xph-list-extension
        Parameters:
        aList - The new list member to set. May be null.

      • setSubject

        public void setSubject​(@Nullable
                       List<DocumentType.Subject> aList)
        Created by ph-jaxb22-plugin -Xph-list-extension
        Parameters:
        aList - The new list member to set. May be null.

      • hasTitleEntries

        public boolean hasTitleEntries()
        Created by ph-jaxb22-plugin -Xph-list-extension
        Returns:
        true if at least one item is contained, false otherwise.

      • hasNoTitleEntries

        public boolean hasNoTitleEntries()
        Created by ph-jaxb22-plugin -Xph-list-extension
        Returns:
        true if no item is contained, false otherwise.

      • getTitleCount

        @Nonnegative
public int getTitleCount()
        Created by ph-jaxb22-plugin -Xph-list-extension
        Returns:
        The number of contained elements. Always ≥ 0.

      • getTitleAtIndex

        @Nullable
public LanguageStringType getTitleAtIndex​(@Nonnegative
                                          int index)
                                   throws IndexOutOfBoundsException
        Created by ph-jaxb22-plugin -Xph-list-extension
        Parameters:
        index - The index to retrieve
        Returns:
        The element at the specified index. May be null
        Throws:
        IndexOutOfBoundsException - if the index is invalid!

      • addTitle

        public void addTitle​(@Nonnull
                     LanguageStringType elem)
        Created by ph-jaxb22-plugin -Xph-list-extension
        Parameters:
        elem - The element to be added. May not be null.

      • hasLanguageEntries

        public boolean hasLanguageEntries()
        Created by ph-jaxb22-plugin -Xph-list-extension
        Returns:
        true if at least one item is contained, false otherwise.

      • hasNoLanguageEntries

        public boolean hasNoLanguageEntries()
        Created by ph-jaxb22-plugin -Xph-list-extension
        Returns:
        true if no item is contained, false otherwise.

      • getLanguageCount

        @Nonnegative
public int getLanguageCount()
        Created by ph-jaxb22-plugin -Xph-list-extension
        Returns:
        The number of contained elements. Always ≥ 0.

      • addLanguage

        public void addLanguage​(@Nonnull
                        DocumentType.Language elem)
        Created by ph-jaxb22-plugin -Xph-list-extension
        Parameters:
        elem - The element to be added. May not be null.

      • hasSubjectEntries

        public boolean hasSubjectEntries()
        Created by ph-jaxb22-plugin -Xph-list-extension
        Returns:
        true if at least one item is contained, false otherwise.

      • hasNoSubjectEntries

        public boolean hasNoSubjectEntries()
        Created by ph-jaxb22-plugin -Xph-list-extension
        Returns:
        true if no item is contained, false otherwise.

      • getSubjectCount

        @Nonnegative
public int getSubjectCount()
        Created by ph-jaxb22-plugin -Xph-list-extension
        Returns:
        The number of contained elements. Always ≥ 0.

      • addSubject

        public void addSubject​(@Nonnull
                       DocumentType.Subject elem)
        Created by ph-jaxb22-plugin -Xph-list-extension
        Parameters:
        elem - The element to be added. May not be null.

      • cloneTo

        public void cloneTo​(@Nonnull
                    DocumentType ret)
        This method clones all values from this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2
        Parameters:
        ret - The target object to clone to. May not be null.

      • clone

        @Nonnull
@ReturnsMutableCopy
public DocumentType clone()
        Created by ph-jaxb22-plugin -Xph-cloneable2
        Specified by:
        clone in interface com.helger.commons.lang.IExplicitlyCloneable
        Overrides:
        clone in class Object
        Returns:
        The cloned object. Never null.