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

Class EntitlementType

  • All Implemented Interfaces:
    com.helger.commons.lang.IExplicitlyCloneable, Cloneable
    @CodingStyleguideUnaware
public class EntitlementType
extends Object
implements com.helger.commons.lang.IExplicitlyCloneable
    A right, e.g. to practice a profession or perform a task, as a result of the acquisition of knowledge, skills, responsibility and/or autonomy. Other examples: - the right to be a member of an organisation - the right to follow a certain learning opportunity - the right to follow a certain career - ...

    Java class for EntitlementType complex type.

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

     <complexType name="EntitlementType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="identifier" type="{http://data.europa.eu/europass/model/credentials#}IdentifierType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="title" type="{http://data.europa.eu/europass/model/credentials#}LanguageStringType" maxOccurs="unbounded"/>
         <element name="description" type="{http://data.europa.eu/europass/model/credentials#}NoteType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="issuedDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
         <element name="expiryDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
         <element name="additionalNote" type="{http://data.europa.eu/europass/model/credentials#}NoteType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="specifiedBy" type="{http://data.europa.eu/europass/model/credentials#}IdReferenceType" minOccurs="0"/>
         <element name="wasDerivedFrom" type="{http://data.europa.eu/europass/model/credentials#}RestrictedAchievementsType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="hasPart" type="{http://data.europa.eu/europass/model/credentials#}EntitlementType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" use="required" type="{http://data.europa.eu/europass/model/credentials#}IdType" />
     </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

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

    • Constructor Detail

      • EntitlementType

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

    • Method Detail

      • getIdentifier

        @Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List<IdentifierType> getIdentifier()
        Gets the value of the identifier 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 identifier property.

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

            getIdentifier().add(newItem);

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

      • 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

      • getDescription

        @Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List<NoteType> getDescription()
        Gets the value of the description 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 description property.

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

            getDescription().add(newItem);

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

      • getIssuedDate

        @Nullable
public com.helger.commons.datetime.OffsetDate getIssuedDate()
        Gets the value of the issuedDate property.
        Returns:
        possible object is String

      • setIssuedDate

        public void setIssuedDate​(@Nullable
                          com.helger.commons.datetime.OffsetDate value)
        Sets the value of the issuedDate property.
        Parameters:
        value - allowed object is String

      • getExpiryDate

        @Nullable
public com.helger.commons.datetime.OffsetDate getExpiryDate()
        Gets the value of the expiryDate property.
        Returns:
        possible object is String

      • setExpiryDate

        public void setExpiryDate​(@Nullable
                          com.helger.commons.datetime.OffsetDate value)
        Sets the value of the expiryDate property.
        Parameters:
        value - allowed object is String

      • getAdditionalNote

        @Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List<NoteType> getAdditionalNote()
        Gets the value of the additionalNote 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 additionalNote property.

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

            getAdditionalNote().add(newItem);

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

      • getSpecifiedBy

        @Nullable
public IdReferenceType getSpecifiedBy()
        Gets the value of the specifiedBy property.
        Returns:
        possible object is IdReferenceType

      • setSpecifiedBy

        public void setSpecifiedBy​(@Nullable
                           IdReferenceType value)
        Sets the value of the specifiedBy property.
        Parameters:
        value - allowed object is IdReferenceType

      • getWasDerivedFrom

        @Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List<RestrictedAchievementsType> getWasDerivedFrom()
        Gets the value of the wasDerivedFrom 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 wasDerivedFrom property.

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

            getWasDerivedFrom().add(newItem);

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

      • getHasPart

        @Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List<EntitlementType> getHasPart()
        Gets the value of the hasPart 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 hasPart property.

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

            getHasPart().add(newItem);

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

      • getId

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

      • setId

        public void setId​(@Nullable
                  String value)
        Sets the value of the id 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

      • setIdentifier

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

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

      • setDescription

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

      • setAdditionalNote

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

      • setWasDerivedFrom

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

      • setHasPart

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

      • hasIdentifierEntries

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

      • hasNoIdentifierEntries

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

      • getIdentifierCount

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

      • getIdentifierAtIndex

        @Nullable
public IdentifierType getIdentifierAtIndex​(@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!

      • addIdentifier

        public void addIdentifier​(@Nonnull
                          IdentifierType elem)
        Created by ph-jaxb22-plugin -Xph-list-extension
        Parameters:
        elem - The element to be added. May not 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.

      • hasDescriptionEntries

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

      • hasNoDescriptionEntries

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

      • getDescriptionCount

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

      • getDescriptionAtIndex

        @Nullable
public NoteType getDescriptionAtIndex​(@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!

      • addDescription

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

      • hasAdditionalNoteEntries

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

      • hasNoAdditionalNoteEntries

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

      • getAdditionalNoteCount

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

      • getAdditionalNoteAtIndex

        @Nullable
public NoteType getAdditionalNoteAtIndex​(@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!

      • addAdditionalNote

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

      • hasWasDerivedFromEntries

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

      • hasNoWasDerivedFromEntries

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

      • getWasDerivedFromCount

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

      • addWasDerivedFrom

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

      • hasHasPartEntries

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

      • hasNoHasPartEntries

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

      • getHasPartCount

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

      • getHasPartAtIndex

        @Nullable
public EntitlementType getHasPartAtIndex​(@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!

      • addHasPart

        public void addHasPart​(@Nonnull
                       EntitlementType 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
                    EntitlementType 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 EntitlementType 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.

      • getIssuedDateLocal

        @Nullable
public LocalDate getIssuedDateLocal()
        Created by ph-jaxb22-plugin -Xph-offset-dt-extension
        Returns:
        The LocalDate representation of issuedDate. May be null.

      • setIssuedDate

        public void setIssuedDate​(@Nullable
                          LocalDate aValue)
        Created by ph-jaxb22-plugin -Xph-offset-dt-extension
        Parameters:
        aValue - The LocalDate to set. May be null.

      • getExpiryDateLocal

        @Nullable
public LocalDate getExpiryDateLocal()
        Created by ph-jaxb22-plugin -Xph-offset-dt-extension
        Returns:
        The LocalDate representation of expiryDate. May be null.

      • setExpiryDate

        public void setExpiryDate​(@Nullable
                          LocalDate aValue)
        Created by ph-jaxb22-plugin -Xph-offset-dt-extension
        Parameters:
        aValue - The LocalDate to set. May be null.