Class PersonNameType
- java.lang.Object
-
- tr.gov.efatura.useraccount.PersonNameBaseType
-
- tr.gov.efatura.useraccount.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 Summary
Constructors Constructor Description PersonNameType()Default constructor
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddAlternateScriptPersonName(AlternateScriptPersonNameType elem)Created by ph-jaxb22-plugin -Xph-list-extensionvoidaddValidFrom(String elem)Created by ph-jaxb22-plugin -Xph-list-extensionvoidaddValidTo(String elem)Created by ph-jaxb22-plugin -Xph-list-extensionPersonNameTypeclone()Created by ph-jaxb22-plugin -Xph-cloneable2voidcloneTo(PersonNameType ret)This method clones all values fromthisto the passed object.booleanequals(Object o)Created by ph-jaxb22-plugin -Xph-equalshashcodeList<AlternateScriptPersonNameType>getAlternateScriptPersonName()Gets the value of the alternateScriptPersonName property.AlternateScriptPersonNameTypegetAlternateScriptPersonNameAtIndex(int index)Created by ph-jaxb22-plugin -Xph-list-extensionintgetAlternateScriptPersonNameCount()Created by ph-jaxb22-plugin -Xph-list-extensionStringgetNameTypeCode()Gets the value of the nameTypeCode property.StringgetScriptCode()Gets the value of the scriptCode property.UserAreaTypegetUserArea()Gets the value of the userArea property.List<String>getValidFrom()Gets the value of the validFrom property.StringgetValidFromAtIndex(int index)Created by ph-jaxb22-plugin -Xph-list-extensionintgetValidFromCount()Created by ph-jaxb22-plugin -Xph-list-extensionList<String>getValidTo()Gets the value of the validTo property.StringgetValidToAtIndex(int index)Created by ph-jaxb22-plugin -Xph-list-extensionintgetValidToCount()Created by ph-jaxb22-plugin -Xph-list-extensionbooleanhasAlternateScriptPersonNameEntries()Created by ph-jaxb22-plugin -Xph-list-extensioninthashCode()Created by ph-jaxb22-plugin -Xph-equalshashcodebooleanhasNoAlternateScriptPersonNameEntries()Created by ph-jaxb22-plugin -Xph-list-extensionbooleanhasNoValidFromEntries()Created by ph-jaxb22-plugin -Xph-list-extensionbooleanhasNoValidToEntries()Created by ph-jaxb22-plugin -Xph-list-extensionbooleanhasValidFromEntries()Created by ph-jaxb22-plugin -Xph-list-extensionbooleanhasValidToEntries()Created by ph-jaxb22-plugin -Xph-list-extensionBooleanisLegalNameIndicator()Gets the value of the legalNameIndicator property.voidsetAlternateScriptPersonName(List<AlternateScriptPersonNameType> aList)Created by ph-jaxb22-plugin -Xph-list-extensionvoidsetLegalNameIndicator(Boolean value)Sets the value of the legalNameIndicator property.voidsetNameTypeCode(String value)Sets the value of the nameTypeCode property.voidsetScriptCode(String value)Sets the value of the scriptCode property.voidsetUserArea(UserAreaType value)Sets the value of the userArea property.voidsetValidFrom(List<String> aList)Created by ph-jaxb22-plugin -Xph-list-extensionvoidsetValidTo(List<String> aList)Created by ph-jaxb22-plugin -Xph-list-extensionStringtoString()Created by ph-jaxb22-plugin -Xph-tostring-
Methods inherited from class tr.gov.efatura.useraccount.PersonNameBaseType
addFamilyName, addGivenName, addQualificationAffixCode, addTitleAffixCode, cloneTo, getFamilyName, getFamilyNameAtIndex, getFamilyNameCount, getFormattedName, getFormattedNameValue, getFormerFamilyName, getFormerFamilyNameValue, getGenerationAffixCode, getGenerationAffixCodeValue, getGivenName, getGivenNameAtIndex, getGivenNameCount, getLegalName, getLegalNameValue, getMiddleName, getMiddleNameValue, getPersonNameInitials, getPersonNameInitialsValue, getPreferredName, getPreferredNameValue, getPreferredSalutationCode, getPreferredSalutationCodeValue, getQualificationAffixCode, getQualificationAffixCodeAtIndex, getQualificationAffixCodeCount, getTitleAffixCode, getTitleAffixCodeAtIndex, getTitleAffixCodeCount, hasFamilyNameEntries, hasGivenNameEntries, hasNoFamilyNameEntries, hasNoGivenNameEntries, hasNoQualificationAffixCodeEntries, hasNoTitleAffixCodeEntries, hasQualificationAffixCodeEntries, hasTitleAffixCodeEntries, setFamilyName, setFormattedName, setFormattedName, setFormerFamilyName, setFormerFamilyName, setGenerationAffixCode, setGenerationAffixCode, setGivenName, setLegalName, setLegalName, setMiddleName, setMiddleName, setPersonNameInitials, setPersonNameInitials, setPreferredName, setPreferredName, setPreferredSalutationCode, setPreferredSalutationCode, setQualificationAffixCode, setTitleAffixCode
-
-
-
-
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
setmethod 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
-
getUserArea
@Nullable public UserAreaType getUserArea()
Gets the value of the userArea property.- Returns:
- possible object is
UserAreaType
-
setUserArea
public void setUserArea(@Nullable UserAreaType value)
Sets the value of the userArea property.- Parameters:
value- allowed object isUserAreaType
-
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 isString
-
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 isString
-
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 isBoolean
-
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
setmethod 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
setmethod 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
-
equals
public boolean equals(Object o)
Created by ph-jaxb22-plugin -Xph-equalshashcode- Overrides:
equalsin classPersonNameBaseType
-
hashCode
public int hashCode()
Created by ph-jaxb22-plugin -Xph-equalshashcode- Overrides:
hashCodein classPersonNameBaseType
-
toString
public String toString()
Created by ph-jaxb22-plugin -Xph-tostring- Overrides:
toStringin classPersonNameBaseType
-
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 benull.
-
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 benull.
-
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 benull.
-
hasAlternateScriptPersonNameEntries
public boolean hasAlternateScriptPersonNameEntries()
Created by ph-jaxb22-plugin -Xph-list-extension- Returns:
trueif at least one item is contained,falseotherwise.
-
hasNoAlternateScriptPersonNameEntries
public boolean hasNoAlternateScriptPersonNameEntries()
Created by ph-jaxb22-plugin -Xph-list-extension- Returns:
trueif no item is contained,falseotherwise.
-
getAlternateScriptPersonNameCount
@Nonnegative public int getAlternateScriptPersonNameCount()
Created by ph-jaxb22-plugin -Xph-list-extension- Returns:
- The number of contained elements. Always ≥ 0.
-
getAlternateScriptPersonNameAtIndex
@Nullable public AlternateScriptPersonNameType getAlternateScriptPersonNameAtIndex(@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!
-
addAlternateScriptPersonName
public void addAlternateScriptPersonName(@Nonnull AlternateScriptPersonNameType elem)
Created by ph-jaxb22-plugin -Xph-list-extension- Parameters:
elem- The element to be added. May not benull.
-
hasValidFromEntries
public boolean hasValidFromEntries()
Created by ph-jaxb22-plugin -Xph-list-extension- Returns:
trueif at least one item is contained,falseotherwise.
-
hasNoValidFromEntries
public boolean hasNoValidFromEntries()
Created by ph-jaxb22-plugin -Xph-list-extension- Returns:
trueif no item is contained,falseotherwise.
-
getValidFromCount
@Nonnegative public int getValidFromCount()
Created by ph-jaxb22-plugin -Xph-list-extension- Returns:
- The number of contained elements. Always ≥ 0.
-
getValidFromAtIndex
@Nullable public String getValidFromAtIndex(@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!
-
addValidFrom
public void addValidFrom(@Nonnull String elem)
Created by ph-jaxb22-plugin -Xph-list-extension- Parameters:
elem- The element to be added. May not benull.
-
hasValidToEntries
public boolean hasValidToEntries()
Created by ph-jaxb22-plugin -Xph-list-extension- Returns:
trueif at least one item is contained,falseotherwise.
-
hasNoValidToEntries
public boolean hasNoValidToEntries()
Created by ph-jaxb22-plugin -Xph-list-extension- Returns:
trueif no item is contained,falseotherwise.
-
getValidToCount
@Nonnegative public int getValidToCount()
Created by ph-jaxb22-plugin -Xph-list-extension- Returns:
- The number of contained elements. Always ≥ 0.
-
getValidToAtIndex
@Nullable public String getValidToAtIndex(@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!
-
addValidTo
public void addValidTo(@Nonnull String elem)
Created by ph-jaxb22-plugin -Xph-list-extension- Parameters:
elem- The element to be added. May not benull.
-
cloneTo
public void cloneTo(@Nonnull PersonNameType ret)
This method clones all values fromthisto 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 benull.
-
clone
@Nonnull @ReturnsMutableCopy public PersonNameType clone()
Created by ph-jaxb22-plugin -Xph-cloneable2- Specified by:
clonein interfacecom.helger.commons.lang.IExplicitlyCloneable- Overrides:
clonein classPersonNameBaseType- Returns:
- The cloned object. Never
null.
-
-