Class CommunicationABIEType

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

    @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

    See Also:
    Serialized Form
    • Constructor Detail

      • CommunicationABIEType

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

      • setUseCode

        public void setUseCode​(@Nullable
                               UseCodeType value)
        Sets the value of the useCode property.
        Parameters:
        value - allowed object is UseCodeType
      • getCountryDialing

        @Nullable
        public TextType getCountryDialing()
        Gets the value of the countryDialing property.
        Returns:
        possible object is TextType
      • setCountryDialing

        public void setCountryDialing​(@Nullable
                                      TextType value)
        Sets the value of the countryDialing property.
        Parameters:
        value - allowed object is TextType
      • getAreaDialing

        @Nullable
        public TextType getAreaDialing()
        Gets the value of the areaDialing property.
        Returns:
        possible object is TextType
      • setAreaDialing

        public void setAreaDialing​(@Nullable
                                   TextType value)
        Sets the value of the areaDialing property.
        Parameters:
        value - allowed object is TextType
      • getDialNumber

        @Nullable
        public TextType getDialNumber()
        Gets the value of the dialNumber property.
        Returns:
        possible object is TextType
      • setDialNumber

        public void setDialNumber​(@Nullable
                                  TextType value)
        Sets the value of the dialNumber property.
        Parameters:
        value - allowed object is TextType
      • getExtension

        @Nullable
        public TextType getExtension()
        Gets the value of the extension property.
        Returns:
        possible object is TextType
      • setExtension

        public void setExtension​(@Nullable
                                 TextType value)
        Sets the value of the extension property.
        Parameters:
        value - allowed object is TextType
      • getAccess

        @Nullable
        public TextType getAccess()
        Gets the value of the access property.
        Returns:
        possible object is TextType
      • setAccess

        public void setAccess​(@Nullable
                              TextType value)
        Sets the value of the access property.
        Parameters:
        value - allowed object is TextType
      • setAddress

        public void setAddress​(@Nullable
                               AddressType value)
        Sets the value of the address property.
        Parameters:
        value - allowed object is AddressType
      • getURI

        @Nullable
        public String getURI()
        Gets the value of the uri property.
        Returns:
        possible object is String
      • setURI

        public void setURI​(@Nullable
                           String value)
        Sets the value of the uri property.
        Parameters:
        value - allowed object is String
      • isHTMLPreferredIndicator

        public Boolean isHTMLPreferredIndicator()
        Gets the value of the htmlPreferredIndicator property.
        Returns:
        possible object is Boolean
      • setHTMLPreferredIndicator

        public void setHTMLPreferredIndicator​(@Nullable
                                              Boolean value)
        Sets the value of the htmlPreferredIndicator property.
        Parameters:
        value - allowed object is Boolean
      • getText

        @Nonnull
        @ReturnsMutableObject("JAXB implementation style")
        public List<TextType> getText()
        Gets the value of the text 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 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

      • setUserArea

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

        public void setSequence​(@Nullable
                                BigInteger value)
        Sets the value of the sequence property.
        Parameters:
        value - allowed object is BigInteger
      • isPreferredIndicator

        public Boolean isPreferredIndicator()
        Gets the value of the preferredIndicator property.
        Returns:
        possible object is Boolean
      • setPreferredIndicator

        public void setPreferredIndicator​(@Nullable
                                          Boolean value)
        Sets the value of the preferredIndicator 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

      • 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
      • setText

        public void setText​(@Nullable
                            List<TextType> 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.
      • hasTextEntries

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

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

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

        public void addText​(@Nonnull
                            TextType 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
                            CommunicationABIEType 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 CommunicationABIEType 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.
      • setChannelCode

        @Nonnull
        public ChannelCodeType setChannelCode​(@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 ChannelCodeType and never null
      • setUseCode

        @Nonnull
        public UseCodeType setUseCode​(@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 UseCodeType and never null
      • setCountryDialing

        @Nonnull
        public TextType setCountryDialing​(@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
      • setAreaDialing

        @Nonnull
        public TextType setAreaDialing​(@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
      • setDialNumber

        @Nonnull
        public TextType setDialNumber​(@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
      • setExtension

        @Nonnull
        public TextType setExtension​(@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
      • setAccess

        @Nonnull
        public TextType setAccess​(@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
      • getChannelCodeValue

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

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

        @Nullable
        public String getCountryDialingValue()
        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
      • getAreaDialingValue

        @Nullable
        public String getAreaDialingValue()
        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
      • getDialNumberValue

        @Nullable
        public String getDialNumberValue()
        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
      • getExtensionValue

        @Nullable
        public String getExtensionValue()
        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
      • getAccessValue

        @Nullable
        public String getAccessValue()
        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