Package de4a.dba.canonical_evidence.v0

Class LegalEntityType

  • All Implemented Interfaces:
    com.helger.commons.lang.IExplicitlyCloneable, Cloneable
    @CodingStyleguideUnaware
public class LegalEntityType
extends Object
implements com.helger.commons.lang.IExplicitlyCloneable
    Company's legal information - CompanyName: This is the primary name of the company. Can be provided for multiple languages. - CompanyType: Type of the company based on ISO 20275 (e.g: SA, PLC, LLC, GmbH etc) - CompanyStatus: Company status as defined in BRIS (closed, struck off the register, wound up, dissolved, economically active or inactive) - CompanyActivity: The activity of a company - RegistrationDate: Date of registration of the company - CompanyEndDate: The company end date - CompanyEUID: Identification of the company following the BRIS-structure: country code + register identifier + registration number + verification digit (optional) - VatNumber: The VAT registration number of the company - CompanyContactData: the contact information of the company (email and Telephone) - RegisteredAddress: Links a Legal Entity to its registered address. - PostalAddress: Company physical address - HasBranch: The branch information

    Java class for LegalEntityType complex type.

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

     <complexType name="LegalEntityType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="CompanyName" type="{urn:de4a:dba:canonical-evidence:v0.5}NamesType" maxOccurs="unbounded"/>
         <element name="CompanyType" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="CompanyStatus" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="CompanyActivity" type="{urn:de4a:dba:canonical-evidence:v0.5}ActivityType"/>
         <element name="RegistrationDate" type="{http://www.w3.org/2001/XMLSchema}date"/>
         <element name="CompanyEndDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
         <element name="CompanyEUID" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="VatNumber" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="CompanyContactData" type="{urn:de4a:dba:canonical-evidence:v0.5}ContactPointType" minOccurs="0"/>
         <element name="RegisteredAddress" type="{urn:de4a:dba:canonical-evidence:v0.5}AddressType" maxOccurs="unbounded"/>
         <element name="PostalAddress" type="{urn:de4a:dba:canonical-evidence:v0.5}AddressType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="HasBranch" type="{urn:de4a:dba:canonical-evidence:v0.5}BranchType" 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

    This class contains methods created by ph-jaxb22-plugin -Xph-offset-dt-extension

    • Constructor Detail

      • LegalEntityType

        public LegalEntityType()
        Default constructor
        Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

    • Method Detail

      • getCompanyName

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

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

            getCompanyName().add(newItem);

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

      • getCompanyType

        @Nullable
public String getCompanyType()
        Gets the value of the companyType property.
        Returns:
        possible object is String

      • setCompanyType

        public void setCompanyType​(@Nullable
                           String value)
        Sets the value of the companyType property.
        Parameters:
        value - allowed object is String

      • getCompanyStatus

        @Nullable
public String getCompanyStatus()
        Gets the value of the companyStatus property.
        Returns:
        possible object is String

      • setCompanyStatus

        public void setCompanyStatus​(@Nullable
                             String value)
        Sets the value of the companyStatus property.
        Parameters:
        value - allowed object is String

      • getCompanyActivity

        @Nullable
public ActivityType getCompanyActivity()
        Gets the value of the companyActivity property.
        Returns:
        possible object is ActivityType

      • setCompanyActivity

        public void setCompanyActivity​(@Nullable
                               ActivityType value)
        Sets the value of the companyActivity property.
        Parameters:
        value - allowed object is ActivityType

      • getRegistrationDate

        @Nullable
public com.helger.commons.datetime.OffsetDate getRegistrationDate()
        Gets the value of the registrationDate property.
        Returns:
        possible object is String

      • setRegistrationDate

        public void setRegistrationDate​(@Nullable
                                com.helger.commons.datetime.OffsetDate value)
        Sets the value of the registrationDate property.
        Parameters:
        value - allowed object is String

      • getCompanyEndDate

        @Nullable
public com.helger.commons.datetime.OffsetDate getCompanyEndDate()
        Gets the value of the companyEndDate property.
        Returns:
        possible object is String

      • setCompanyEndDate

        public void setCompanyEndDate​(@Nullable
                              com.helger.commons.datetime.OffsetDate value)
        Sets the value of the companyEndDate property.
        Parameters:
        value - allowed object is String

      • getCompanyEUID

        @Nullable
public String getCompanyEUID()
        Gets the value of the companyEUID property.
        Returns:
        possible object is String

      • setCompanyEUID

        public void setCompanyEUID​(@Nullable
                           String value)
        Sets the value of the companyEUID property.
        Parameters:
        value - allowed object is String

      • getVatNumber

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

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

            getVatNumber().add(newItem);

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

      • getCompanyContactData

        @Nullable
public ContactPointType getCompanyContactData()
        Gets the value of the companyContactData property.
        Returns:
        possible object is ContactPointType

      • setCompanyContactData

        public void setCompanyContactData​(@Nullable
                                  ContactPointType value)
        Sets the value of the companyContactData property.
        Parameters:
        value - allowed object is ContactPointType

      • getRegisteredAddress

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

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

            getRegisteredAddress().add(newItem);

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

      • getPostalAddress

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

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

            getPostalAddress().add(newItem);

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

      • getHasBranch

        @Nullable
public BranchType getHasBranch()
        Gets the value of the hasBranch property.
        Returns:
        possible object is BranchType

      • setHasBranch

        public void setHasBranch​(@Nullable
                         BranchType value)
        Sets the value of the hasBranch property.
        Parameters:
        value - allowed object is BranchType

      • 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

      • setCompanyName

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

      • setVatNumber

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

      • setRegisteredAddress

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

      • setPostalAddress

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

      • hasCompanyNameEntries

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

      • hasNoCompanyNameEntries

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

      • getCompanyNameCount

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

      • getCompanyNameAtIndex

        @Nullable
public NamesType getCompanyNameAtIndex​(@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!

      • addCompanyName

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

      • hasVatNumberEntries

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

      • hasNoVatNumberEntries

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

      • getVatNumberCount

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

      • getVatNumberAtIndex

        @Nullable
public String getVatNumberAtIndex​(@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!

      • addVatNumber

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

      • hasRegisteredAddressEntries

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

      • hasNoRegisteredAddressEntries

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

      • getRegisteredAddressCount

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

      • getRegisteredAddressAtIndex

        @Nullable
public AddressType getRegisteredAddressAtIndex​(@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!

      • addRegisteredAddress

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

      • hasPostalAddressEntries

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

      • hasNoPostalAddressEntries

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

      • getPostalAddressCount

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

      • getPostalAddressAtIndex

        @Nullable
public AddressType getPostalAddressAtIndex​(@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!

      • addPostalAddress

        public void addPostalAddress​(@Nonnull
                             AddressType 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
                    LegalEntityType 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 LegalEntityType 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.

      • getRegistrationDateLocal

        @Nullable
public LocalDate getRegistrationDateLocal()
        Created by ph-jaxb22-plugin -Xph-offset-dt-extension
        Returns:
        The LocalDate representation of registrationDate. May be null.

      • setRegistrationDate

        public void setRegistrationDate​(@Nullable
                                LocalDate aValue)
        Created by ph-jaxb22-plugin -Xph-offset-dt-extension
        Parameters:
        aValue - The LocalDate to set. May be null.

      • getCompanyEndDateLocal

        @Nullable
public LocalDate getCompanyEndDateLocal()
        Created by ph-jaxb22-plugin -Xph-offset-dt-extension
        Returns:
        The LocalDate representation of companyEndDate. May be null.

      • setCompanyEndDate

        public void setCompanyEndDate​(@Nullable
                              LocalDate aValue)
        Created by ph-jaxb22-plugin -Xph-offset-dt-extension
        Parameters:
        aValue - The LocalDate to set. May be null.