Java tutorial
/** * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this file, * You can obtain one at http://mozilla.org/MPL/2.0/. */ package org.mifosplatform.portfolio.client.domain; import java.util.ArrayList; import java.util.Date; import java.util.HashSet; import java.util.LinkedHashMap; import java.util.List; import java.util.Map; import java.util.Set; import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.FetchType; import javax.persistence.JoinColumn; import javax.persistence.JoinTable; import javax.persistence.ManyToMany; import javax.persistence.ManyToOne; import javax.persistence.OneToOne; import javax.persistence.Table; import javax.persistence.Temporal; import javax.persistence.TemporalType; import javax.persistence.Transient; import javax.persistence.UniqueConstraint; import org.apache.commons.lang.ObjectUtils; import org.apache.commons.lang.StringUtils; import org.hibernate.annotations.LazyCollection; import org.hibernate.annotations.LazyCollectionOption; import org.joda.time.LocalDate; import org.joda.time.format.DateTimeFormatter; import org.mifosplatform.infrastructure.codes.domain.CodeValue; import org.mifosplatform.infrastructure.core.api.JsonCommand; import org.mifosplatform.infrastructure.core.data.ApiParameterError; import org.mifosplatform.infrastructure.core.data.DataValidatorBuilder; import org.mifosplatform.infrastructure.core.exception.PlatformApiDataValidationException; import org.mifosplatform.infrastructure.core.service.DateUtils; import org.mifosplatform.infrastructure.documentmanagement.domain.Image; import org.mifosplatform.infrastructure.security.service.RandomPasswordGenerator; import org.mifosplatform.organisation.office.domain.Office; import org.mifosplatform.organisation.staff.domain.Staff; import org.mifosplatform.portfolio.client.api.ClientApiConstants; import org.mifosplatform.portfolio.group.domain.Group; import org.mifosplatform.useradministration.domain.AppUser; import org.springframework.data.jpa.domain.AbstractPersistable; @Entity @Table(name = "m_client", uniqueConstraints = { @UniqueConstraint(columnNames = { "account_no" }, name = "account_no_UNIQUE"), // @UniqueConstraint(columnNames = { "mobile_no" }, name = "mobile_no_UNIQUE") }) public final class Client extends AbstractPersistable<Long> { @Column(name = "account_no", length = 20, unique = true, nullable = false) private String accountNumber; @ManyToOne @JoinColumn(name = "office_id", nullable = false) private Office office; @ManyToOne @JoinColumn(name = "transfer_to_office_id", nullable = true) private Office transferToOffice; @OneToOne(optional = true) @JoinColumn(name = "image_id", nullable = true) private Image image; /** * A value from {@link ClientStatus}. */ @Column(name = "status_enum", nullable = false) private Integer status; @Column(name = "activation_date", nullable = true) @Temporal(TemporalType.DATE) private Date activationDate; @Column(name = "office_joining_date", nullable = true) @Temporal(TemporalType.DATE) private Date officeJoiningDate; @Column(name = "firstname", length = 50) private String firstname; @Column(name = "middlename", length = 50) private String middlename; @Column(name = "lastname", length = 50) private String lastname; @Column(name = "fullname", length = 100) private String fullname; @Column(name = "display_name", length = 100, nullable = false) private String displayName; @Column(name = "mobile_no", length = 50, nullable = false, unique = true) private String mobileNo; @Column(name = "external_id", length = 100, nullable = true, unique = true) private String externalId; @ManyToOne @JoinColumn(name = "staff_id") private Staff staff; @LazyCollection(LazyCollectionOption.FALSE) @ManyToMany @JoinTable(name = "m_group_client", joinColumns = @JoinColumn(name = "client_id"), inverseJoinColumns = @JoinColumn(name = "group_id")) private Set<Group> groups; @Transient private boolean accountNumberRequiresAutoGeneration = false; @ManyToOne(fetch = FetchType.LAZY) @JoinColumn(name = "closure_reason_cv_id", nullable = true) private CodeValue closureReason; @Column(name = "closedon_date", nullable = true) @Temporal(TemporalType.DATE) private Date closureDate; @ManyToOne(optional = true) @JoinColumn(name = "closedon_userid", nullable = true) private AppUser closeddBy; @Column(name = "submittedon_date", nullable = true) @Temporal(TemporalType.DATE) private Date submittedOnDate; @ManyToOne(optional = true) @JoinColumn(name = "submittedon_userid", nullable = true) private AppUser submittedBy; @ManyToOne(optional = true) @JoinColumn(name = "activatedon_userid", nullable = true) private AppUser activatedBy; @Column(name = "email_id", length = 50) private String emailId; @Column(name = "address", nullable = true) private String address; @Column(name = "TIN", nullable = true) private String taxIdentificationNumber; public static Client createNew(final AppUser currentUser, final Office clientOffice, final Group clientParentGroup, final Staff staff, final JsonCommand command) { final String accountNo = command.stringValueOfParameterNamed(ClientApiConstants.accountNoParamName); final String externalId = command.stringValueOfParameterNamed(ClientApiConstants.externalIdParamName); final String mobileNo = command.stringValueOfParameterNamed(ClientApiConstants.mobileNoParamName); final String firstname = command.stringValueOfParameterNamed(ClientApiConstants.firstnameParamName); final String middlename = command.stringValueOfParameterNamed(ClientApiConstants.middlenameParamName); final String lastname = command.stringValueOfParameterNamed(ClientApiConstants.lastnameParamName); final String fullname = command.stringValueOfParameterNamed(ClientApiConstants.fullnameParamName); final String emailid = command.stringValueOfParameterNamed("mailId"); final String address = command.stringValueOfParameterNamed("address"); final String taxIdentificationNumber = command.stringValueOfParameterNamed("TIN"); ClientStatus status = ClientStatus.PENDING; boolean active = false; if (command.hasParameter("active")) { active = command.booleanPrimitiveValueOfParameterNamed(ClientApiConstants.activeParamName); } LocalDate activationDate = null; LocalDate officeJoiningDate = null; if (active) { status = ClientStatus.ACTIVE; activationDate = command.localDateValueOfParameterNamed(ClientApiConstants.activationDateParamName); officeJoiningDate = activationDate; } LocalDate submittedOnDate = new LocalDate(); if (active && submittedOnDate.isAfter(activationDate)) { submittedOnDate = activationDate; } if (command.hasParameter(ClientApiConstants.submittedOnDateParamName)) { submittedOnDate = command.localDateValueOfParameterNamed(ClientApiConstants.submittedOnDateParamName); } return new Client(currentUser, status, clientOffice, clientParentGroup, accountNo, firstname, middlename, lastname, fullname, activationDate, officeJoiningDate, externalId, mobileNo, staff, submittedOnDate, emailid, address, taxIdentificationNumber); } protected Client() { // } private Client(final AppUser currentUser, final ClientStatus status, final Office office, final Group clientParentGroup, final String accountNo, final String firstname, final String middlename, final String lastname, final String fullname, final LocalDate activationDate, final LocalDate officeJoiningDate, final String externalId, final String mobileNo, final Staff staff, final LocalDate submittedOnDate, final String emailId, final String address, final String taxIdentificationNumber) { if (StringUtils.isBlank(accountNo)) { this.accountNumber = new RandomPasswordGenerator(19).generate(); this.accountNumberRequiresAutoGeneration = true; } else { this.accountNumber = accountNo; } if (StringUtils.isNotBlank(emailId)) { this.emailId = emailId.trim(); } else { this.emailId = null; } this.submittedOnDate = submittedOnDate.toDate(); this.submittedBy = currentUser; this.status = status.getValue(); this.office = office; if (StringUtils.isNotBlank(externalId)) { this.externalId = externalId.trim(); } else { this.externalId = null; } if (StringUtils.isNotBlank(mobileNo)) { this.mobileNo = mobileNo.trim(); } else { this.mobileNo = null; } if (activationDate != null) { this.activationDate = activationDate.toDateTimeAtStartOfDay().toDate(); this.activatedBy = currentUser; } if (officeJoiningDate != null) { this.officeJoiningDate = officeJoiningDate.toDateTimeAtStartOfDay().toDate(); } if (StringUtils.isNotBlank(firstname)) { this.firstname = firstname.trim(); } else { this.firstname = null; } if (StringUtils.isNotBlank(middlename)) { this.middlename = middlename.trim(); } else { this.middlename = null; } if (StringUtils.isNotBlank(lastname)) { this.lastname = lastname.trim(); } else { this.lastname = null; } if (StringUtils.isNotBlank(fullname)) { this.fullname = fullname.trim(); } else { this.fullname = null; } if (clientParentGroup != null) { this.groups = new HashSet<Group>(); this.groups.add(clientParentGroup); } if (StringUtils.isNotBlank(address)) { this.address = address.trim(); } else { this.address = null; } if (StringUtils.isNotBlank(taxIdentificationNumber)) { this.taxIdentificationNumber = taxIdentificationNumber.trim(); } else { this.taxIdentificationNumber = null; } this.staff = staff; deriveDisplayName(); validate(); } private void validate() { final List<ApiParameterError> dataValidationErrors = new ArrayList<ApiParameterError>(); validateNameParts(dataValidationErrors); validateActivationDate(dataValidationErrors); if (!dataValidationErrors.isEmpty()) { throw new PlatformApiDataValidationException(dataValidationErrors); } } public boolean isAccountNumberRequiresAutoGeneration() { return this.accountNumberRequiresAutoGeneration; } public void setAccountNumberRequiresAutoGeneration(final boolean accountNumberRequiresAutoGeneration) { this.accountNumberRequiresAutoGeneration = accountNumberRequiresAutoGeneration; } public boolean identifiedBy(final String identifier) { return identifier.equalsIgnoreCase(this.externalId); } public boolean identifiedBy(final Long clientId) { return getId().equals(clientId); } public void updateAccountNo(final String accountIdentifier) { this.accountNumber = accountIdentifier; this.accountNumberRequiresAutoGeneration = false; } public void activate(final AppUser currentUser, final DateTimeFormatter formatter, final LocalDate activationLocalDate) { if (isActive()) { final String defaultUserMessage = "Cannot activate client. Client is already active."; final ApiParameterError error = ApiParameterError.parameterError("error.msg.clients.already.active", defaultUserMessage, ClientApiConstants.activationDateParamName, activationLocalDate.toString(formatter)); final List<ApiParameterError> dataValidationErrors = new ArrayList<ApiParameterError>(); dataValidationErrors.add(error); throw new PlatformApiDataValidationException(dataValidationErrors); } this.activationDate = activationLocalDate.toDate(); this.activatedBy = currentUser; this.officeJoiningDate = this.activationDate; this.status = ClientStatus.ACTIVE.getValue(); validate(); } public boolean isNotActive() { return !isActive(); } public boolean isActive() { return ClientStatus.fromInt(this.status).isActive(); } public boolean isClosed() { return ClientStatus.fromInt(this.status).isClosed(); } public boolean isTransferInProgress() { return ClientStatus.fromInt(this.status).isTransferInProgress(); } public boolean isTransferOnHold() { return ClientStatus.fromInt(this.status).isTransferOnHold(); } public boolean isTransferInProgressOrOnHold() { return isTransferInProgress() || isTransferOnHold(); } public boolean isNotPending() { return !isPending(); } public boolean isPending() { return ClientStatus.fromInt(this.status).isPending(); } private boolean isDateInTheFuture(final LocalDate localDate) { return localDate.isAfter(DateUtils.getLocalDateOfTenant()); } public Map<String, Object> update(final JsonCommand command) { final Map<String, Object> actualChanges = new LinkedHashMap<String, Object>(9); if (command.isChangeInIntegerParameterNamed(ClientApiConstants.statusParamName, this.status)) { final Integer newValue = command.integerValueOfParameterNamed(ClientApiConstants.statusParamName); actualChanges.put(ClientApiConstants.statusParamName, ClientEnumerations.status(newValue)); this.status = ClientStatus.fromInt(newValue).getValue(); } if (command.isChangeInStringParameterNamed(ClientApiConstants.accountNoParamName, this.accountNumber)) { final String newValue = command.stringValueOfParameterNamed(ClientApiConstants.accountNoParamName); actualChanges.put(ClientApiConstants.accountNoParamName, newValue); this.accountNumber = StringUtils.defaultIfEmpty(newValue, null); } if (command.isChangeInStringParameterNamed(ClientApiConstants.externalIdParamName, this.externalId)) { final String newValue = command.stringValueOfParameterNamed(ClientApiConstants.externalIdParamName); actualChanges.put(ClientApiConstants.externalIdParamName, newValue); this.externalId = StringUtils.defaultIfEmpty(newValue, null); } if (command.isChangeInStringParameterNamed(ClientApiConstants.mobileNoParamName, this.mobileNo)) { final String newValue = command.stringValueOfParameterNamed(ClientApiConstants.mobileNoParamName); actualChanges.put(ClientApiConstants.mobileNoParamName, newValue); this.mobileNo = StringUtils.defaultIfEmpty(newValue, null); } if (command.isChangeInStringParameterNamed(ClientApiConstants.firstnameParamName, this.firstname)) { final String newValue = command.stringValueOfParameterNamed(ClientApiConstants.firstnameParamName); actualChanges.put(ClientApiConstants.firstnameParamName, newValue); this.firstname = StringUtils.defaultIfEmpty(newValue, null); } if (command.isChangeInStringParameterNamed(ClientApiConstants.middlenameParamName, this.middlename)) { final String newValue = command.stringValueOfParameterNamed(ClientApiConstants.middlenameParamName); actualChanges.put(ClientApiConstants.middlenameParamName, newValue); this.middlename = StringUtils.defaultIfEmpty(newValue, null); } if (command.isChangeInStringParameterNamed(ClientApiConstants.lastnameParamName, this.lastname)) { final String newValue = command.stringValueOfParameterNamed(ClientApiConstants.lastnameParamName); actualChanges.put(ClientApiConstants.lastnameParamName, newValue); this.lastname = StringUtils.defaultIfEmpty(newValue, null); } if (command.isChangeInStringParameterNamed(ClientApiConstants.fullnameParamName, this.fullname)) { final String newValue = command.stringValueOfParameterNamed(ClientApiConstants.fullnameParamName); actualChanges.put(ClientApiConstants.fullnameParamName, newValue); this.fullname = newValue; } if (command.isChangeInStringParameterNamed(ClientApiConstants.addressParamName, this.address)) { final String newValue = command.stringValueOfParameterNamed(ClientApiConstants.addressParamName); actualChanges.put(ClientApiConstants.addressParamName, newValue); this.address = StringUtils.defaultIfEmpty(newValue, null); } if (command.isChangeInStringParameterNamed(ClientApiConstants.taxIdentificationNumberParamName, this.taxIdentificationNumber)) { final String newValue = command .stringValueOfParameterNamed(ClientApiConstants.taxIdentificationNumberParamName); actualChanges.put(ClientApiConstants.taxIdentificationNumberParamName, newValue); this.taxIdentificationNumber = StringUtils.defaultIfEmpty(newValue, null); } if (command.isChangeInLongParameterNamed(ClientApiConstants.staffIdParamName, staffId())) { final Long newValue = command.longValueOfParameterNamed(ClientApiConstants.staffIdParamName); actualChanges.put(ClientApiConstants.staffIdParamName, newValue); } final String dateFormatAsInput = command.dateFormat(); final String localeAsInput = command.locale(); if (command.isChangeInLocalDateParameterNamed(ClientApiConstants.activationDateParamName, getActivationLocalDate())) { final String valueAsInput = command .stringValueOfParameterNamed(ClientApiConstants.activationDateParamName); actualChanges.put(ClientApiConstants.activationDateParamName, valueAsInput); actualChanges.put(ClientApiConstants.dateFormatParamName, dateFormatAsInput); actualChanges.put(ClientApiConstants.localeParamName, localeAsInput); final LocalDate newValue = command .localDateValueOfParameterNamed(ClientApiConstants.activationDateParamName); this.activationDate = newValue.toDate(); this.officeJoiningDate = this.activationDate; } validate(); deriveDisplayName(); return actualChanges; } private void validateNameParts(final List<ApiParameterError> dataValidationErrors) { final DataValidatorBuilder baseDataValidator = new DataValidatorBuilder(dataValidationErrors) .resource("client"); if (StringUtils.isNotBlank(this.fullname)) { baseDataValidator.reset().parameter(ClientApiConstants.firstnameParamName).value(this.firstname) .mustBeBlankWhenParameterProvided(ClientApiConstants.fullnameParamName, this.fullname); baseDataValidator.reset().parameter(ClientApiConstants.middlenameParamName).value(this.middlename) .mustBeBlankWhenParameterProvided(ClientApiConstants.fullnameParamName, this.fullname); baseDataValidator.reset().parameter(ClientApiConstants.lastnameParamName).value(this.lastname) .mustBeBlankWhenParameterProvided(ClientApiConstants.fullnameParamName, this.fullname); } else { baseDataValidator.reset().parameter(ClientApiConstants.firstnameParamName).value(this.firstname) .notBlank().notExceedingLengthOf(50); baseDataValidator.reset().parameter(ClientApiConstants.middlenameParamName).value(this.middlename) .ignoreIfNull().notExceedingLengthOf(50); baseDataValidator.reset().parameter(ClientApiConstants.lastnameParamName).value(this.lastname) .notBlank().notExceedingLengthOf(50); } } private void validateActivationDate(final List<ApiParameterError> dataValidationErrors) { if (getSubmittedOnDate() != null && isDateInTheFuture(getSubmittedOnDate())) { final String defaultUserMessage = "submitted date cannot be in the future."; final ApiParameterError error = ApiParameterError.parameterError( "error.msg.clients.submittedOnDate.in.the.future", defaultUserMessage, ClientApiConstants.submittedOnDateParamName, this.submittedOnDate); dataValidationErrors.add(error); } if (getActivationLocalDate() != null && getSubmittedOnDate() != null && getSubmittedOnDate().isAfter(getActivationLocalDate())) { final String defaultUserMessage = "submitted date cannot be after the activation date"; final ApiParameterError error = ApiParameterError.parameterError( "error.msg.clients.submittedOnDate.after.activation.date", defaultUserMessage, ClientApiConstants.submittedOnDateParamName, this.submittedOnDate); dataValidationErrors.add(error); } if (getActivationLocalDate() != null && isDateInTheFuture(getActivationLocalDate())) { final String defaultUserMessage = "Activation date cannot be in the future."; final ApiParameterError error = ApiParameterError.parameterError( "error.msg.clients.activationDate.in.the.future", defaultUserMessage, ClientApiConstants.activationDateParamName, getActivationLocalDate()); dataValidationErrors.add(error); } if (getActivationLocalDate() != null) { if (this.office.isOpeningDateAfter(getActivationLocalDate())) { final String defaultUserMessage = "Client activation date cannot be a date before the office opening date."; final ApiParameterError error = ApiParameterError.parameterError( "error.msg.clients.activationDate.cannot.be.before.office.activation.date", defaultUserMessage, ClientApiConstants.activationDateParamName, getActivationLocalDate()); dataValidationErrors.add(error); } } } private void deriveDisplayName() { StringBuilder nameBuilder = new StringBuilder(); if (StringUtils.isNotBlank(this.firstname)) { nameBuilder.append(this.firstname).append(' '); } if (StringUtils.isNotBlank(this.middlename)) { nameBuilder.append(this.middlename).append(' '); } if (StringUtils.isNotBlank(this.lastname)) { nameBuilder.append(this.lastname); } if (StringUtils.isNotBlank(this.fullname)) { nameBuilder = new StringBuilder(this.fullname); } this.displayName = nameBuilder.toString(); } public LocalDate getSubmittedOnDate() { return (LocalDate) ObjectUtils.defaultIfNull(new LocalDate(this.submittedOnDate), null); } public LocalDate getActivationLocalDate() { LocalDate activationLocalDate = null; if (this.activationDate != null) { activationLocalDate = LocalDate.fromDateFields(this.activationDate); } return activationLocalDate; } public LocalDate getOfficeJoiningLocalDate() { LocalDate officeJoiningLocalDate = null; if (this.officeJoiningDate != null) { officeJoiningLocalDate = LocalDate.fromDateFields(this.officeJoiningDate); } return officeJoiningLocalDate; } public boolean isOfficeIdentifiedBy(final Long officeId) { return this.office.identifiedBy(officeId); } public Long officeId() { return this.office.getId(); } public void setImage(final Image image) { this.image = image; } public Image getImage() { return this.image; } public String mobileNo() { return this.mobileNo; } public void setMobileNo(final String mobileNo) { this.mobileNo = mobileNo; } public String getDisplayName() { return this.displayName; } public void setDisplayName(final String displayName) { this.displayName = displayName; } public Office getOffice() { return this.office; } public Office getTransferToOffice() { return this.transferToOffice; } public void updateOffice(final Office office) { this.office = office; } public void updateTransferToOffice(final Office office) { this.transferToOffice = office; } public void updateOfficeJoiningDate(final Date date) { this.officeJoiningDate = date; } private Long staffId() { Long staffId = null; if (this.staff != null) { staffId = this.staff.getId(); } return staffId; } public void updateStaff(final Staff staff) { this.staff = staff; } public Staff getStaff() { return this.staff; } public void unassignStaff() { this.staff = null; } public void assignStaff(final Staff staff) { this.staff = staff; } public Set<Group> getGroups() { return this.groups; } public void close(final AppUser currentUser, final CodeValue closureReason, final Date closureDate) { this.closureReason = closureReason; this.closureDate = closureDate; this.closeddBy = currentUser; this.status = ClientStatus.CLOSED.getValue(); } public Integer getStatus() { return this.status; } public void setStatus(final Integer status) { this.status = status; } public boolean isActivatedAfter(final LocalDate submittedOn) { return getActivationLocalDate().isAfter(submittedOn); } public boolean isChildOfGroup(final Long groupId) { if (groupId != null && this.groups != null && !this.groups.isEmpty()) { for (final Group group : this.groups) { if (group.getId().equals(groupId)) { return true; } } } return false; } public String getFirstname() { return firstname; } public String getEmailId() { return emailId; } public String getMobileNo() { return mobileNo; } }