com.anaptecs.jeaf.accounting.Individual Maven / Gradle / Ivy

Go to download
/*
 * anaptecs GmbH, Ricarda-Huch-Str. 71, 72760 Reutlingen, Germany
 *
 * Copyright 2004 - 2019. All rights reserved.
 */
package com.anaptecs.jeaf.accounting;

import javax.validation.ConstraintViolationException;

import com.anaptecs.jeaf.tools.api.validation.ValidationTools;
import com.anaptecs.jeaf.xfun.api.common.ObjectIdentity;

public class Individual extends Customer {
  /**
   * Default serial version uid.
   */
  private static final long serialVersionUID = 1L;

  /**
   * Constant for the name of attribute "person".
   */
  public static final String PERSON = "person";

  private Person person;

  /**
   * Default constructor is only intended to be used for deserialization by tools like Jackson for JSON. For "normal"
   * object creation builder should be used instead.
   */
  protected Individual( ) {
  }

  /**
   * Initialize object using the passed builder.
   *
   * @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
   */
  protected Individual( Builder pBuilder ) {
    // Call constructor of super class.
    super(pBuilder);
    // Read attribute values from builder.
    person = pBuilder.person;
    if (person != null) {
      // As association is bidirectional we also have to set it in the other direction.
      person.setCustomer((Individual) this);
    }
  }

  /**
   * Method returns a new builder.
   *
   * @return {@link Builder} New builder that can be used to create new Individual objects.
   */
  public static Builder builder( ) {
    return new Builder();
  }

  /**
   * Convenience method to create new instance of class Individual.
   *
   *
   * @param pActive Value to which {@link #active} should be set.
   *
   * @param pStreet Value to which {@link #street} should be set.
   *
   * @param pZipCode Value to which {@link #zipCode} should be set.
   *
   * @param pCity Value to which {@link #city} should be set.
   *
   * @param pCountry Value to which {@link #country} should be set.
   *
   * @param pPerson Value to which {@link #person} should be set.
   *
   * @return {@link Individual}
   */
  public static Individual of( Boolean pActive, String pStreet, Integer pZipCode, String pCity, String pCountry,
      Person pPerson ) {
    Individual.Builder lBuilder = Individual.builder();
    lBuilder.setActive(pActive);
    lBuilder.setStreet(pStreet);
    lBuilder.setZipCode(pZipCode);
    lBuilder.setCity(pCity);
    lBuilder.setCountry(pCountry);
    lBuilder.setPerson(pPerson);
    return lBuilder.build();
  }

  /**
   * Class implements builder to create a new instance of class Individual.
   */
  public static class Builder extends Customer.Builder {
    private Person person;

    /**
     * Use {@link Individual#builder()} instead of private constructor to create new builder.
     */
    protected Builder( ) {
      super();
    }

    /**
     * Use {@link Individual#builder(Individual)} instead of private constructor to create new builder.
     */
    protected Builder( Individual pObject ) {
      super(pObject);
      if (pObject != null) {
        // Read attribute values from passed object.
        this.setPerson(pObject.person);
      }
    }

    /**
     * Method sets the identifier for the object created using the builder. The reference may be null since an id is not
     * mandatory.
     */
    @Override
    public Builder setID( ObjectIdentity pObjectID ) {
      super.setID(pObjectID);
      return this;
    }

    /**
     * Method sets attribute {@link #active}.

     *
     * @param pActive Value to which {@link #active} should be set.
     * @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
     */
    @Override
    public Builder setActive( Boolean pActive ) {
      // Call super class implementation.
      super.setActive(pActive);
      return this;
    }

    /**
     * Method sets attribute {@link #street}.

     *
     * @param pStreet Value to which {@link #street} should be set.
     * @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
     */
    @Override
    public Builder setStreet( String pStreet ) {
      // Call super class implementation.
      super.setStreet(pStreet);
      return this;
    }

    /**
     * Method sets attribute {@link #zipCode}.

     *
     * @param pZipCode Value to which {@link #zipCode} should be set.
     * @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
     */
    @Override
    public Builder setZipCode( Integer pZipCode ) {
      // Call super class implementation.
      super.setZipCode(pZipCode);
      return this;
    }

    /**
     * Method sets attribute {@link #city}.

     *
     * @param pCity Value to which {@link #city} should be set.
     * @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
     */
    @Override
    public Builder setCity( String pCity ) {
      // Call super class implementation.
      super.setCity(pCity);
      return this;
    }

    /**
     * Method sets attribute {@link #country}.

     *
     * @param pCountry Value to which {@link #country} should be set.
     * @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
     */
    @Override
    public Builder setCountry( String pCountry ) {
      // Call super class implementation.
      super.setCountry(pCountry);
      return this;
    }

    /**
     * Method sets association {@link #person}.

     *
     * @param pPerson Value to which {@link #person} should be set.
     * @return {@link Builder} Instance of this builder to support chaining setters. Method never returns null.
     */
    public Builder setPerson( Person pPerson ) {
      person = pPerson;
      return this;
    }

    /**
     * Method creates a new instance of class Individual. The object will be initialized with the values of the builder.
     *
     * @return Individual Created object. The method never returns null.
     */
    public Individual build( ) {
      Individual lObject = new Individual(this);
      ValidationTools.getValidationTools().enforceObjectValidation(lObject);
      return lObject;
    }

    /**
     * Method creates a new validated instance of class Individual. The object will be initialized with the values of
     * the builder and validated afterwards.
     *
     * @return Individual Created and validated object. The method never returns null.
     * @throws ConstraintViolationException in case that one or more validations for the created object failed.
     */
    public Individual buildValidated( ) throws ConstraintViolationException {
      Individual lObject = this.build();
      ValidationTools.getValidationTools().enforceObjectValidation(lObject);
      return lObject;
    }
  }

  /**
   * Method returns association {@link #person}.

   *
   * @return {@link Person} Value to which {@link #person} is set.
   */
  public Person getPerson( ) {
    return person;
  }

  /**
   * Method sets association {@link #person}.

   *
   * @param pPerson Value to which {@link #person} should be set.
   */
  public void setPerson( Person pPerson ) {
    // Release already referenced object before setting a new association.
    if (person != null) {
      person.unsetCustomer();
    }
    person = pPerson;
    // The association is set in both directions because within the UML model it is defined to be bidirectional.
    // In case that one side will be removed from the association the other side will also be removed.
    if (pPerson != null && this.equals(pPerson.getCustomer()) == false) {
      pPerson.setCustomer((Individual) this);
    }
  }

  /**
   * Method unsets {@link #person}.
   */
  public final void unsetPerson( ) {
    // The association is set in both directions because within the UML model it is defined to be bidirectional.
    // In case that one side will be removed from the association the other side will also be removed.
    Person lPerson = person;
    person = null;
    if (lPerson != null && this.equals(lPerson.getCustomer()) == true) {
      lPerson.unsetCustomer();
    }
  }

  /**
   * Method creates a new builder and initializes it with the data of this object.
   *
   * @return {@link Builder} New builder that can be used to create new Individual objects. The method never returns
   * null.
   */
  public Builder toBuilder( ) {
    return new Builder(this);
  }
}