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

Class EuropassCredentialType

  • All Implemented Interfaces:
    com.helger.commons.lang.IExplicitlyCloneable, Cloneable
    @CodingStyleguideUnaware
public class EuropassCredentialType
extends Object
implements com.helger.commons.lang.IExplicitlyCloneable
    A set of claims made by an issuer in Europe, using the Europass Standards. A Europass credential is a set of one or more claims which may be used to demonstrate that the owner has certain skills or has achieved certain learning outcomes through formal, non-formal or informal learning.

    Java class for EuropassCredentialType complex type.

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

     <complexType name="EuropassCredentialType">
   <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="type" type="{http://data.europa.eu/europass/model/credentials#}CredentialTypeType"/>
         <element ref="{http://data.europa.eu/europass/model/credentials/w3c#}validFrom" minOccurs="0"/>
         <element ref="{http://data.europa.eu/europass/model/credentials/w3c#}issued"/>
         <element ref="{http://data.europa.eu/europass/model/credentials/w3c#}validUntil" minOccurs="0"/>
         <element ref="{http://data.europa.eu/europass/model/credentials/w3c#}issuer"/>
         <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="credentialSubject" type="{http://data.europa.eu/europass/model/credentials#}CredentialSubjectType"/>
         <element name="learningSpecificationReferences" type="{http://data.europa.eu/europass/model/credentials#}LearningSpecificationReferencesType" minOccurs="0"/>
         <element name="learningOutcomeReferences" type="{http://data.europa.eu/europass/model/credentials#}LearningOutcomeReferencesType" minOccurs="0"/>
         <element name="learningActivitySpecificationReferences" type="{http://data.europa.eu/europass/model/credentials#}LearningActivitySpecificationReferencesType" minOccurs="0"/>
         <element name="assessmentSpecificationReferences" type="{http://data.europa.eu/europass/model/credentials#}AssessmentSpecificationReferencesType" minOccurs="0"/>
         <element name="entitlementSpecificationReferences" type="{http://data.europa.eu/europass/model/credentials#}EntitlementSpecificationReferencesType" minOccurs="0"/>
         <element name="learningOpportunityReferences" type="{http://data.europa.eu/europass/model/credentials#}LearningOpportunityReferencesType" minOccurs="0"/>
         <element name="agentReferences" type="{http://data.europa.eu/europass/model/credentials#}AgentReferencesType" minOccurs="0"/>
         <element name="awardingProcessReferences" type="{http://data.europa.eu/europass/model/credentials#}AwardingProcessReferencesType" minOccurs="0"/>
         <element name="accreditationReferences" type="{http://data.europa.eu/europass/model/credentials#}AccreditationReferencesType" minOccurs="0"/>
         <element name="scoringSchemeReferences" type="{http://data.europa.eu/europass/model/credentials#}ScoringSchemeReferencesType" minOccurs="0"/>
         <element name="semanticFrameworkReferences" type="{http://data.europa.eu/europass/model/credentials#}FrameworkReferencesType" minOccurs="0"/>
         <element name="displayParameters" type="{http://data.europa.eu/europass/model/credentials#}DisplayParametersType" minOccurs="0"/>
         <element name="attachmentList" type="{http://data.europa.eu/europass/model/credentials#}AttachmentListType" minOccurs="0"/>
         <element name="proof">
           <complexType>
             <complexContent>
               <extension base="{http://data.europa.eu/europass/model/credentials/w3c#}ProofType">
                 <sequence>
                   <element ref="{http://www.w3.org/2000/09/xmldsig#}Signature" minOccurs="0"/>
                 </sequence>
               </extension>
             </complexContent>
           </complexType>
         </element>
         <element name="childCredentials" type="{http://data.europa.eu/europass/model/credentials#}ChildCredentialsType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute ref="{http://data.europa.eu/europass/model/credentials/w3c#}id use="required""/>
       <attribute name="xsdVersion" default="0.10.0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}token">
             <enumeration value="0.10.0"/>
           </restriction>
         </simpleType>
       </attribute>
     </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

      • EuropassCredentialType

        public EuropassCredentialType()
        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

      • getValidFrom

        @Nullable
public OffsetDateTime getValidFrom()
        The valid from date. The value of validFrom property represents the date and time from which the credential is valid.
        Returns:
        possible object is String

      • setValidFrom

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

      • getIssued

        @Nullable
public OffsetDateTime getIssued()
        The issued date. A verifiable credential MUST have an issuedDate property. The value represents the date and time the credential was issued. Note that this date represents the earliest date when the information associated with the credentialSubject property became valid. This is not the date of generation of the credential.
        Returns:
        possible object is String

      • setIssued

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

      • getValidUntil

        @Nullable
public OffsetDateTime getValidUntil()
        The valid until date. The value of the validUntil property represents the date and time the credential ceases to be valid.
        Returns:
        possible object is String

      • setValidUntil

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

      • getIssuer

        @Nullable
public IdReferenceType getIssuer()
        The issuer of the Europass credential. Must be an organization. It must refer to an existing organization-record in the 'agentReferences'-section.
        Returns:
        possible object is IdReferenceType

      • setIssuer

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

      • 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

      • setCredentialSubject

        public void setCredentialSubject​(@Nullable
                                 CredentialSubjectType value)
        Sets the value of the credentialSubject property.
        Parameters:
        value - allowed object is CredentialSubjectType

      • setAgentReferences

        public void setAgentReferences​(@Nullable
                               AgentReferencesType value)
        Sets the value of the agentReferences property.
        Parameters:
        value - allowed object is AgentReferencesType

      • setSemanticFrameworkReferences

        public void setSemanticFrameworkReferences​(@Nullable
                                           FrameworkReferencesType value)
        Sets the value of the semanticFrameworkReferences property.
        Parameters:
        value - allowed object is FrameworkReferencesType

      • setDisplayParameters

        public void setDisplayParameters​(@Nullable
                                 DisplayParametersType value)
        Sets the value of the displayParameters property.
        Parameters:
        value - allowed object is DisplayParametersType

      • setAttachmentList

        public void setAttachmentList​(@Nullable
                              AttachmentListType value)
        Sets the value of the attachmentList property.
        Parameters:
        value - allowed object is AttachmentListType

      • getChildCredentials

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

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

            getChildCredentials().add(newItem);

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

      • getId

        @Nullable
public String getId()
        A portable identifier of the credential. (i.e. a urn in the uuid namespace, urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6)
        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

      • getXsdVersion

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

      • setXsdVersion

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

      • setChildCredentials

        public void setChildCredentials​(@Nullable
                                List<ChildCredentialsType> 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.

      • hasChildCredentialsEntries

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

      • hasNoChildCredentialsEntries

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

      • getChildCredentialsCount

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

      • getChildCredentialsAtIndex

        @Nullable
public ChildCredentialsType getChildCredentialsAtIndex​(@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!

      • addChildCredentials

        public void addChildCredentials​(@Nonnull
                                ChildCredentialsType 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
                    EuropassCredentialType 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 EuropassCredentialType 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.

      • getValidFromLocal

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

      • setValidFrom

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

      • getIssuedLocal

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

      • setIssued

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

      • getValidUntilLocal

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

      • setValidUntil

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