sirius.biz.model.ContactData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sirius-biz Show documentation
Provides a framework for building web based business applications
There is a newer version: 9.6
/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - [email protected]
 */

package sirius.biz.model;

import sirius.biz.web.Autoloaded;
import sirius.db.mixing.Column;
import sirius.db.mixing.Composite;
import sirius.db.mixing.annotations.BeforeSave;
import sirius.db.mixing.annotations.Length;
import sirius.db.mixing.annotations.NullAllowed;
import sirius.db.mixing.annotations.Transient;
import sirius.db.mixing.annotations.Trim;
import sirius.kernel.commons.Strings;
import sirius.kernel.di.std.Part;
import sirius.kernel.health.Exceptions;
import sirius.kernel.health.HandledException;
import sirius.kernel.nls.NLS;
import sirius.web.mails.Mails;

import java.util.regex.Pattern;

/**
 * Provides various contact information for a person or company which can be embedded into other entities or mixins.
 */
public class ContactData extends Composite {

    /**
     * Validates a phone numner.
     */
    public static final Pattern VALID_PHONE_NUMBER =
            Pattern.compile("\\+?\\d+( \\d+)*( */( *\\d+)+)?( *\\-( *\\d+)+)?");

    @Transient
    private boolean validatePhoneNumbers;

    /**
     * Contains an email address.
     * 
     * If the field is filled, it has to be a valid email address, otherwise an exception will be thrown.
     */
    public static final Column EMAIL = Column.named("email");
    @Trim
    @NullAllowed
    @Autoloaded
    @Length(150)
    private String email;

    /**
     * Contains a phone number.
     * 

     * If the field is filled and validatePhoneNumbers is true, an exception is thrown
     * if the phone number has an illegal format.
     */
    public static final Column PHONE = Column.named("phone");
    @Trim
    @NullAllowed
    @Autoloaded
    @Length(150)
    private String phone;

    /**
     * Contains a fax number.
     * 

     * If the field is filled and validatePhoneNumbers is true, an exception is thrown
     * if the fax number has an illegal format.
     */
    public static final Column FAX = Column.named("fax");
    @Trim
    @NullAllowed
    @Autoloaded
    @Length(150)
    private String fax;

    /**
     * Contains a mobile number.
     * 
     * If the field is filled and validatePhoneNumbers is true, an exception is thrown
     * if the mobile phone number has an illegal format.
     */
    public static final Column MOBILE = Column.named("mobile");
    @Trim
    @NullAllowed
    @Autoloaded
    @Length(150)
    private String mobile;

    @Part
    private static Mails mails;

    /**
     * Creates a new instance.
     *
     * @param validatePhoneNumbers determines if phone numbers should be validated or not
     */
    public ContactData(boolean validatePhoneNumbers) {
        this.validatePhoneNumbers = validatePhoneNumbers;
    }

    @BeforeSave
    protected void onSave() throws Exception {
        if (Strings.isFilled(email)) {
            mails.failForInvalidEmail(email, null);
        }

        if (validatePhoneNumbers) {
            if (Strings.isFilled(phone) && !VALID_PHONE_NUMBER.matcher(phone).matches()) {
                throw invalidPhoneException(NLS.get("Model.phone"), phone);
            }
            if (Strings.isFilled(fax) && !VALID_PHONE_NUMBER.matcher(fax).matches()) {
                throw invalidPhoneException(NLS.get("Model.fax"), fax);
            }
            if (Strings.isFilled(mobile) && !VALID_PHONE_NUMBER.matcher(mobile).matches()) {
                throw invalidPhoneException(NLS.get("Model.mobile"), mobile);
            }
        }
    }

    private HandledException invalidPhoneException(String field, String value) {
        return Exceptions.createHandled()
                         .withNLSKey("ContactData.invalidPhone")
                         .set("field", field)
                         .set("value", value)
                         .handle();
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }

    public String getFax() {
        return fax;
    }

    public void setFax(String fax) {
        this.fax = fax;
    }

    public String getMobile() {
        return mobile;
    }

    public void setMobile(String mobile) {
        this.mobile = mobile;
    }

    @Override
    public String toString() {
        return email + " / " + phone + " / " + fax + " / " + mobile;
    }
}