@CodingStyleguideUnaware public class CommunicationABIEType extends Object implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
<?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">This
flexibly allows capture of information about a variety of communication channels
(telephone, email, fax, messaging, address, etc.). CommunicationABIEType is
logically derived from UN/CEFACT TBG17 ABIE CommunicationType as defined in the
Reusable Aggregate Business Information Entity (RUABIE) XML Schema file. Note
this version has been modified to meet HR Industry requirments. 1. Includes
effective dating attributes. 2. Preference, sequence, and effective dating are
handled in attributes rather than element. 3. Address based on OAGIS Address
type with exceptions: includes effective dating and current Indicator; uses HR
country code list. 4. Uses HR code lists for ChannelCode and UseCode. </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. Note that Communication allows the capture of an
Address as a communication type. Note that not every use of Address is a
communication. For example, Residence Address and Domicle Address have uses in
the context of payroll tax calculation, benefits plan eligibility determination,
and employment screening that are distinct from usage of an address as a
communication means. IIn this case, the Address 'type' attribute would specify
the address as Residence or Domicile.</ccts:UsageRule>
<?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">Residence
definition: The place of a person's general abode. A person's actual dwelling
place in fact. This may be a temporary residence or a long-term residence.
Residence Address is often a legal or official address for purposes of
determinations such as work eligibility, applicable payroll taxes, and benefits
program eligibility. This also is an address of of importance to processes such
as employment screening that make use of residence history to direct the scope
of screenings that may be conducted. </ccts:UsageRule>
<?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">Domicile
definition: Black's Law Dictionary, Sixth Edition: "A person's legal home. That
place where a man has his true, fixed, and permanent home and principal
establishment, and to which whenever he is absent he has the intention of
returning (emphasis added)(Smith v. Smith, 206 Pa. Super. 310). A person may
have more than one residence but only one domicile. The legal domicile of a
person is important since it, rather than the actual residence, often controls
the jurisdiction of the taxing authorities and determines where a person may
exercise the privilege of voting and other legal rights and privileges." OED:
Domicile n. 2. Law. The place where one has his home or permanent residence, to
which, if absent, he has the intention of returning. In some cases Domicile
Address may be deterimined by, and have significance with repect to,
determinations of applicable taxes or tax reportin.</ccts:UsageRule>
<?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">Formatted
telephone numbers should use the DialNumber element.</ccts:UsageRule>
Java class for CommunicationABIEType complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="CommunicationABIEType">
<complexContent>
<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
<sequence>
<element ref="{http://www.hr-xml.org/3}ChannelCode" minOccurs="0"/>
<element ref="{http://www.hr-xml.org/3}UseCode" minOccurs="0"/>
<choice>
<sequence>
<element ref="{http://www.openapplications.org/oagis/9}CountryDialing" minOccurs="0"/>
<element ref="{http://www.openapplications.org/oagis/9}AreaDialing" minOccurs="0"/>
<element ref="{http://www.openapplications.org/oagis/9}DialNumber" minOccurs="0"/>
<element ref="{http://www.openapplications.org/oagis/9}Extension" minOccurs="0"/>
<element ref="{http://www.openapplications.org/oagis/9}Access" minOccurs="0"/>
</sequence>
<element ref="{http://www.hr-xml.org/3}Address" minOccurs="0"/>
<sequence>
<element ref="{http://www.openapplications.org/oagis/9}URI" minOccurs="0"/>
<element ref="{http://www.openapplications.org/oagis/9}HTMLPreferredIndicator" minOccurs="0"/>
</sequence>
<element ref="{http://www.openapplications.org/oagis/9}Text" maxOccurs="unbounded" minOccurs="0"/>
</choice>
<element ref="{http://www.hr-xml.org/3}UserArea" minOccurs="0"/>
</sequence>
<attGroup ref="{http://www.hr-xml.org/3}EffectiveDateAttributeGroup"/>
<attribute name="sequence" type="{http://www.openapplications.org/oagis/9}PositiveIntegerNumericType" />
<attribute name="preferredIndicator" type="{http://www.openapplications.org/oagis/9}IndicatorType" />
</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
| Constructor and Description |
|---|
CommunicationABIEType()
Default constructor
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
| Modifier and Type | Method and Description |
|---|---|
void |
addText(TextType elem)
Created by ph-jaxb22-plugin -Xph-list-extension
|
void |
addValidFrom(String elem)
Created by ph-jaxb22-plugin -Xph-list-extension
|
void |
addValidTo(String elem)
Created by ph-jaxb22-plugin -Xph-list-extension
|
CommunicationABIEType |
clone()
Created by ph-jaxb22-plugin -Xph-cloneable2
|
void |
cloneTo(CommunicationABIEType ret)
This method clones all values from
this to the passed object. |
boolean |
equals(Object o)
Created by ph-jaxb22-plugin -Xph-equalshashcode
|
TextType |
getAccess()
Gets the value of the access property.
|
String |
getAccessValue()
Get the value of the contained TextType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
AddressType |
getAddress()
Gets the value of the address property.
|
TextType |
getAreaDialing()
Gets the value of the areaDialing property.
|
String |
getAreaDialingValue()
Get the value of the contained TextType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
ChannelCodeType |
getChannelCode()
Gets the value of the channelCode property.
|
String |
getChannelCodeValue()
Get the value of the contained ChannelCodeType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
TextType |
getCountryDialing()
Gets the value of the countryDialing property.
|
String |
getCountryDialingValue()
Get the value of the contained TextType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
TextType |
getDialNumber()
Gets the value of the dialNumber property.
|
String |
getDialNumberValue()
Get the value of the contained TextType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
TextType |
getExtension()
Gets the value of the extension property.
|
String |
getExtensionValue()
Get the value of the contained TextType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
BigInteger |
getSequence()
Gets the value of the sequence property.
|
List<TextType> |
getText()
Gets the value of the text property.
|
TextType |
getTextAtIndex(int index)
Created by ph-jaxb22-plugin -Xph-list-extension
|
int |
getTextCount()
Created by ph-jaxb22-plugin -Xph-list-extension
|
String |
getURI()
Gets the value of the uri property.
|
UseCodeType |
getUseCode()
Gets the value of the useCode property.
|
String |
getUseCodeValue()
Get the value of the contained UseCodeType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
UserAreaType |
getUserArea()
Gets the value of the userArea property.
|
List<String> |
getValidFrom()
Gets the value of the validFrom property.
|
String |
getValidFromAtIndex(int index)
Created by ph-jaxb22-plugin -Xph-list-extension
|
int |
getValidFromCount()
Created by ph-jaxb22-plugin -Xph-list-extension
|
List<String> |
getValidTo()
Gets the value of the validTo property.
|
String |
getValidToAtIndex(int index)
Created by ph-jaxb22-plugin -Xph-list-extension
|
int |
getValidToCount()
Created by ph-jaxb22-plugin -Xph-list-extension
|
int |
hashCode()
Created by ph-jaxb22-plugin -Xph-equalshashcode
|
boolean |
hasNoTextEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
boolean |
hasNoValidFromEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
boolean |
hasNoValidToEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
boolean |
hasTextEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
boolean |
hasValidFromEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
boolean |
hasValidToEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
Boolean |
isHTMLPreferredIndicator()
Gets the value of the htmlPreferredIndicator property.
|
Boolean |
isPreferredIndicator()
Gets the value of the preferredIndicator property.
|
TextType |
setAccess(String valueParam)
Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
void |
setAccess(TextType value)
Sets the value of the access property.
|
void |
setAddress(AddressType value)
Sets the value of the address property.
|
TextType |
setAreaDialing(String valueParam)
Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
void |
setAreaDialing(TextType value)
Sets the value of the areaDialing property.
|
void |
setChannelCode(ChannelCodeType value)
Sets the value of the channelCode property.
|
ChannelCodeType |
setChannelCode(String valueParam)
Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
TextType |
setCountryDialing(String valueParam)
Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
void |
setCountryDialing(TextType value)
Sets the value of the countryDialing property.
|
TextType |
setDialNumber(String valueParam)
Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
void |
setDialNumber(TextType value)
Sets the value of the dialNumber property.
|
TextType |
setExtension(String valueParam)
Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
void |
setExtension(TextType value)
Sets the value of the extension property.
|
void |
setHTMLPreferredIndicator(Boolean value)
Sets the value of the htmlPreferredIndicator property.
|
void |
setPreferredIndicator(Boolean value)
Sets the value of the preferredIndicator property.
|
void |
setSequence(BigInteger value)
Sets the value of the sequence property.
|
void |
setText(List<TextType> aList)
Created by ph-jaxb22-plugin -Xph-list-extension
|
void |
setURI(String value)
Sets the value of the uri property.
|
UseCodeType |
setUseCode(String valueParam)
Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
void |
setUseCode(UseCodeType value)
Sets the value of the useCode property.
|
void |
setUserArea(UserAreaType value)
Sets the value of the userArea property.
|
void |
setValidFrom(List<String> aList)
Created by ph-jaxb22-plugin -Xph-list-extension
|
void |
setValidTo(List<String> aList)
Created by ph-jaxb22-plugin -Xph-list-extension
|
String |
toString()
Created by ph-jaxb22-plugin -Xph-tostring
|
public CommunicationABIEType()
@Nullable public ChannelCodeType getChannelCode()
ChannelCodeTypepublic void setChannelCode(@Nullable ChannelCodeType value)
value - allowed object is
ChannelCodeType@Nullable public UseCodeType getUseCode()
UseCodeTypepublic void setUseCode(@Nullable UseCodeType value)
value - allowed object is
UseCodeType@Nullable public TextType getCountryDialing()
TextTypepublic void setCountryDialing(@Nullable TextType value)
value - allowed object is
TextType@Nullable public TextType getAreaDialing()
TextTypepublic void setAreaDialing(@Nullable TextType value)
value - allowed object is
TextType@Nullable public TextType getDialNumber()
TextTypepublic void setDialNumber(@Nullable TextType value)
value - allowed object is
TextType@Nullable public TextType getExtension()
TextTypepublic void setExtension(@Nullable TextType value)
value - allowed object is
TextType@Nullable public TextType getAccess()
TextTypepublic void setAccess(@Nullable TextType value)
value - allowed object is
TextType@Nullable public AddressType getAddress()
AddressTypepublic void setAddress(@Nullable AddressType value)
value - allowed object is
AddressType@Nullable public String getURI()
Stringpublic void setURI(@Nullable String value)
value - allowed object is
Stringpublic Boolean isHTMLPreferredIndicator()
Booleanpublic void setHTMLPreferredIndicator(@Nullable Boolean value)
value - allowed object is
Boolean@Nonnull @ReturnsMutableObject(value="JAXB implementation style") public List<TextType> getText()
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 text property.
For example, to add a new item, do as follows:
getText().add(newItem);
Objects of the following type(s) are allowed in the list
TextType
@Nullable public UserAreaType getUserArea()
UserAreaTypepublic void setUserArea(@Nullable UserAreaType value)
value - allowed object is
UserAreaType@Nullable public BigInteger getSequence()
BigIntegerpublic void setSequence(@Nullable BigInteger value)
value - allowed object is
BigIntegerpublic Boolean isPreferredIndicator()
Booleanpublic void setPreferredIndicator(@Nullable Boolean value)
value - allowed object is
Boolean@Nonnull @ReturnsMutableObject(value="JAXB implementation style") public List<String> getValidFrom()
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
@Nonnull @ReturnsMutableObject(value="JAXB implementation style") public List<String> getValidTo()
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
public boolean equals(Object o)
public int hashCode()
public String toString()
public void setText(@Nullable List<TextType> aList)
aList - The new list member to set. May be null.public void setValidFrom(@Nullable List<String> aList)
aList - The new list member to set. May be null.public void setValidTo(@Nullable List<String> aList)
aList - The new list member to set. May be null.public boolean hasTextEntries()
true if at least one item is contained, false otherwise.public boolean hasNoTextEntries()
true if no item is contained, false otherwise.@Nonnegative public int getTextCount()
@Nullable public TextType getTextAtIndex(@Nonnegative int index) throws IndexOutOfBoundsException
index - The index to retrievenullIndexOutOfBoundsException - if the index is invalid!public void addText(@Nonnull TextType elem)
elem - The element to be added. May not be null.public boolean hasValidFromEntries()
true if at least one item is contained, false otherwise.public boolean hasNoValidFromEntries()
true if no item is contained, false otherwise.@Nonnegative public int getValidFromCount()
@Nullable public String getValidFromAtIndex(@Nonnegative int index) throws IndexOutOfBoundsException
index - The index to retrievenullIndexOutOfBoundsException - if the index is invalid!public void addValidFrom(@Nonnull String elem)
elem - The element to be added. May not be null.public boolean hasValidToEntries()
true if at least one item is contained, false otherwise.public boolean hasNoValidToEntries()
true if no item is contained, false otherwise.@Nonnegative public int getValidToCount()
@Nullable public String getValidToAtIndex(@Nonnegative int index) throws IndexOutOfBoundsException
index - The index to retrievenullIndexOutOfBoundsException - if the index is invalid!public void addValidTo(@Nonnull String elem)
elem - The element to be added. May not be null.public void cloneTo(@Nonnull CommunicationABIEType ret)
this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2ret - The target object to clone to. May not be null.@Nonnull @ReturnsMutableCopy public CommunicationABIEType clone()
@Nonnull public ChannelCodeType setChannelCode(@Nullable String valueParam)
valueParam - The value to be set. May be null.null@Nonnull public UseCodeType setUseCode(@Nullable String valueParam)
valueParam - The value to be set. May be null.null@Nonnull public TextType setCountryDialing(@Nullable String valueParam)
valueParam - The value to be set. May be null.null@Nonnull public TextType setAreaDialing(@Nullable String valueParam)
valueParam - The value to be set. May be null.null@Nonnull public TextType setDialNumber(@Nullable String valueParam)
valueParam - The value to be set. May be null.null@Nonnull public TextType setExtension(@Nullable String valueParam)
valueParam - The value to be set. May be null.null@Nonnull public TextType setAccess(@Nullable String valueParam)
valueParam - The value to be set. May be null.null@Nullable public String getChannelCodeValue()
null@Nullable public String getUseCodeValue()
null@Nullable public String getCountryDialingValue()
null@Nullable public String getAreaDialingValue()
null@Nullable public String getDialNumberValue()
null@Nullable public String getExtensionValue()
nullCopyright © 2016–2021 Philip Helger. All rights reserved.