Class PersonNameType

  • All Implemented Interfaces:
    com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

    @CodingStyleguideUnaware
    public class PersonNameType
    extends PersonNameBaseType
     <?xml version="1.0" encoding="UTF-8"?><ccts:DictionaryEntryName xmlns:ccts="urn:un:unece:uncefact:documentation:1.1" xmlns="http://www.hr-xml.org/3" xmlns:oa="http://www.openapplications.org/oagis/9" xmlns:xsd="http://www.w3.org/2001/XMLSchema">Person Name. Details</ccts:DictionaryEntryName>
     
     <?xml version="1.0" encoding="UTF-8"?><ccts:DefinitionText xmlns:ccts="urn:un:unece:uncefact:documentation:1.1" xmlns="http://www.hr-xml.org/3" xmlns:oa="http://www.openapplications.org/oagis/9" xmlns:xsd="http://www.w3.org/2001/XMLSchema">A
                                            collection of data representing a person name. </ccts:DefinitionText>
     
     <?xml version="1.0" encoding="UTF-8"?><ccts:UsageRule xmlns:ccts="urn:un:unece:uncefact:documentation:1.1" xmlns="http://www.hr-xml.org/3" xmlns:oa="http://www.openapplications.org/oagis/9" xmlns:xsd="http://www.w3.org/2001/XMLSchema">Various uses
                                            and options are supported. The person name model is intended to be useful across
                                            many cultural contexts. The ordering and presentation of given names and family
                                            names may vary by cultural custom. A person name can be represented as a
                                            formatted string "Mr. John L Smith III, Phd" or represented as discretely
                                            fielded data or both. An option to present a name in an alternative "alphabet"
                                            or script is supported. For example the same name might be presented using
                                            Roman, Kanji, Arabic, or other character sets. Note the term "script" versus
                                            "character set" is used so as not to confuse this issue with concepts such as
                                            "character encoding". </ccts:UsageRule>
     

    Java class for PersonNameType complex type.

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

     <complexType name="PersonNameType">
       <complexContent>
         <extension base="{http://www.hr-xml.org/3}PersonNameBaseType">
           <sequence>
             <element ref="{http://www.hr-xml.org/3}AlternateScriptPersonName" maxOccurs="unbounded" minOccurs="0"/>
             <element ref="{http://www.hr-xml.org/3}UserArea" minOccurs="0"/>
           </sequence>
           <attGroup ref="{http://www.hr-xml.org/3}EffectiveDateAttributeGroup"/>
           <attribute name="scriptCode" type="{http://www.openapplications.org/oagis/9}NormalizedStringType" />
           <attribute name="nameTypeCode" type="{http://www.hr-xml.org/3}NameTypeCodeContentType" />
           <attribute name="legalNameIndicator" type="{http://www.openapplications.org/oagis/9}IndicatorType" />
         </extension>
       </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

      • PersonNameType

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

      • getAlternateScriptPersonName

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

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

            getAlternateScriptPersonName().add(newItem);
         

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

      • setUserArea

        public void setUserArea​(@Nullable
                                UserAreaType value)
        Sets the value of the userArea property.
        Parameters:
        value - allowed object is UserAreaType
      • getScriptCode

        @Nullable
        public String getScriptCode()
        Gets the value of the scriptCode property.
        Returns:
        possible object is String
      • setScriptCode

        public void setScriptCode​(@Nullable
                                  String value)
        Sets the value of the scriptCode property.
        Parameters:
        value - allowed object is String
      • getNameTypeCode

        @Nullable
        public String getNameTypeCode()
        Gets the value of the nameTypeCode property.
        Returns:
        possible object is String
      • setNameTypeCode

        public void setNameTypeCode​(@Nullable
                                    String value)
        Sets the value of the nameTypeCode property.
        Parameters:
        value - allowed object is String
      • isLegalNameIndicator

        public Boolean isLegalNameIndicator()
        Gets the value of the legalNameIndicator property.
        Returns:
        possible object is Boolean
      • setLegalNameIndicator

        public void setLegalNameIndicator​(@Nullable
                                          Boolean value)
        Sets the value of the legalNameIndicator property.
        Parameters:
        value - allowed object is Boolean
      • getValidFrom

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

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

            getValidFrom().add(newItem);
         

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

      • getValidTo

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

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

            getValidTo().add(newItem);
         

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

      • hashCode

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public void addValidTo​(@Nonnull
                               String 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
                            PersonNameType 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 PersonNameType clone()
        Created by ph-jaxb22-plugin -Xph-cloneable2
        Specified by:
        clone in interface com.helger.commons.lang.IExplicitlyCloneable
        Overrides:
        clone in class PersonNameBaseType
        Returns:
        The cloned object. Never null.