Class PersonNameBaseType

  • All Implemented Interfaces:
    com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
    Direct Known Subclasses:
    AlternateScriptPersonNameType, PersonNameType

    @CodingStyleguideUnaware
    public class PersonNameBaseType
    extends Object
    implements Serializable, com.helger.commons.lang.IExplicitlyCloneable

    Java class for PersonNameBaseType complex type.

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

     <complexType name="PersonNameBaseType">
       <complexContent>
         <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
           <sequence>
             <element ref="{http://www.hr-xml.org/3}FormattedName" minOccurs="0"/>
             <element ref="{http://www.hr-xml.org/3}LegalName" minOccurs="0"/>
             <element ref="{http://www.openapplications.org/oagis/9}GivenName" maxOccurs="unbounded" minOccurs="0"/>
             <element ref="{http://www.hr-xml.org/3}PreferredName" minOccurs="0"/>
             <element ref="{http://www.hr-xml.org/3}MiddleName" minOccurs="0"/>
             <element ref="{http://www.hr-xml.org/3}FamilyName" maxOccurs="unbounded" minOccurs="0"/>
             <element ref="{http://www.hr-xml.org/3}FormerFamilyName" minOccurs="0"/>
             <element ref="{http://www.hr-xml.org/3}PreferredSalutationCode" minOccurs="0"/>
             <element ref="{http://www.hr-xml.org/3}GenerationAffixCode" minOccurs="0"/>
             <element ref="{http://www.hr-xml.org/3}QualificationAffixCode" maxOccurs="unbounded" minOccurs="0"/>
             <element ref="{http://www.hr-xml.org/3}TitleAffixCode" maxOccurs="unbounded" minOccurs="0"/>
             <element ref="{http://www.hr-xml.org/3}PersonNameInitials" minOccurs="0"/>
           </sequence>
         </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

    See Also:
    Serialized Form
    • Constructor Detail

      • PersonNameBaseType

        public PersonNameBaseType()
        Default constructor
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
    • Method Detail

      • getGivenName

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

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

            getGivenName().add(newItem);
         

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

      • getPreferredName

        @Nullable
        public TextType getPreferredName()
        Gets the value of the preferredName property.
        Returns:
        possible object is TextType
      • setPreferredName

        public void setPreferredName​(@Nullable
                                     TextType value)
        Sets the value of the preferredName property.
        Parameters:
        value - allowed object is TextType
      • getFamilyName

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

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

            getFamilyName().add(newItem);
         

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

      • setFormerFamilyName

        public void setFormerFamilyName​(@Nullable
                                        FamilyNameType value)
        Sets the value of the formerFamilyName property.
        Parameters:
        value - allowed object is FamilyNameType
      • getPreferredSalutationCode

        @Nullable
        public CodeType getPreferredSalutationCode()
        Gets the value of the preferredSalutationCode property.
        Returns:
        possible object is CodeType
      • setPreferredSalutationCode

        public void setPreferredSalutationCode​(@Nullable
                                               CodeType value)
        Sets the value of the preferredSalutationCode property.
        Parameters:
        value - allowed object is CodeType
      • getGenerationAffixCode

        @Nullable
        public CodeType getGenerationAffixCode()
        Gets the value of the generationAffixCode property.
        Returns:
        possible object is CodeType
      • setGenerationAffixCode

        public void setGenerationAffixCode​(@Nullable
                                           CodeType value)
        Sets the value of the generationAffixCode property.
        Parameters:
        value - allowed object is CodeType
      • getQualificationAffixCode

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

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

            getQualificationAffixCode().add(newItem);
         

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

      • getTitleAffixCode

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

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

            getTitleAffixCode().add(newItem);
         

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

      • getPersonNameInitials

        @Nullable
        public TextType getPersonNameInitials()
        Gets the value of the personNameInitials property.
        Returns:
        possible object is TextType
      • setPersonNameInitials

        public void setPersonNameInitials​(@Nullable
                                          TextType value)
        Sets the value of the personNameInitials property.
        Parameters:
        value - allowed object is TextType
      • 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
      • setGivenName

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public void addTitleAffixCode​(@Nonnull
                                      CodeType 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
                            PersonNameBaseType 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 PersonNameBaseType 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.
      • setPreferredSalutationCode

        @Nonnull
        public CodeType setPreferredSalutationCode​(@Nullable
                                                   String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type CodeType and never null
      • setGenerationAffixCode

        @Nonnull
        public CodeType setGenerationAffixCode​(@Nullable
                                               String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type CodeType and never null
      • setFormattedName

        @Nonnull
        public FormattedNameType setFormattedName​(@Nullable
                                                  String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type FormattedNameType and never null
      • setLegalName

        @Nonnull
        public FormattedNameType setLegalName​(@Nullable
                                              String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type FormattedNameType and never null
      • setPreferredName

        @Nonnull
        public TextType setPreferredName​(@Nullable
                                         String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type TextType and never null
      • setMiddleName

        @Nonnull
        public MiddleNameType setMiddleName​(@Nullable
                                            String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type MiddleNameType and never null
      • setFormerFamilyName

        @Nonnull
        public FamilyNameType setFormerFamilyName​(@Nullable
                                                  String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type FamilyNameType and never null
      • setPersonNameInitials

        @Nonnull
        public TextType setPersonNameInitials​(@Nullable
                                              String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type TextType and never null
      • getFormattedNameValue

        @Nullable
        public String getFormattedNameValue()
        Get the value of the contained FormattedNameType object
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Returns:
        Either the value of the contained FormattedNameType object or null
      • getLegalNameValue

        @Nullable
        public String getLegalNameValue()
        Get the value of the contained FormattedNameType object
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Returns:
        Either the value of the contained FormattedNameType object or null
      • getPreferredNameValue

        @Nullable
        public String getPreferredNameValue()
        Get the value of the contained TextType object
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Returns:
        Either the value of the contained TextType object or null
      • getMiddleNameValue

        @Nullable
        public String getMiddleNameValue()
        Get the value of the contained MiddleNameType object
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Returns:
        Either the value of the contained MiddleNameType object or null
      • getFormerFamilyNameValue

        @Nullable
        public String getFormerFamilyNameValue()
        Get the value of the contained FamilyNameType object
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Returns:
        Either the value of the contained FamilyNameType object or null
      • getPreferredSalutationCodeValue

        @Nullable
        public String getPreferredSalutationCodeValue()
        Get the value of the contained CodeType object
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Returns:
        Either the value of the contained CodeType object or null
      • getGenerationAffixCodeValue

        @Nullable
        public String getGenerationAffixCodeValue()
        Get the value of the contained CodeType object
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Returns:
        Either the value of the contained CodeType object or null
      • getPersonNameInitialsValue

        @Nullable
        public String getPersonNameInitialsValue()
        Get the value of the contained TextType object
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
        Returns:
        Either the value of the contained TextType object or null