[jfinancials-war.git] /

/*
 * Copyright (C) 2017 - 2020 Free Software Foundation
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.mxchange.jfinancials.beans.financial.model.receipt.action;

import java.text.MessageFormat;
import java.util.Date;
import java.util.Objects;
import javax.ejb.EJB;
import javax.enterprise.event.Event;
import javax.enterprise.inject.Any;
import javax.faces.FacesException;
import javax.faces.application.FacesMessage;
import javax.faces.view.ViewScoped;
import javax.inject.Inject;
import javax.inject.Named;
import org.mxchange.jbonuscard.model.bonus_card.BonusCard;
import org.mxchange.jcontactsbusiness.model.branchoffice.BranchOffice;
import org.mxchange.jcontactsbusiness.model.employee.Employable;
import org.mxchange.jfinancials.beans.BaseFinancialsBean;
import org.mxchange.jfinancials.beans.financial.model.receipt.list.FinancialsReceiptListWebViewController;
import org.mxchange.jfinancials.events.receipt.added.ObservableReceiptAddedEvent;
import org.mxchange.jfinancials.events.receipt.added.ReceiptAddedEvent;
import org.mxchange.jfinancials.events.receipt.updated.ObservableReceiptUpdatedEvent;
import org.mxchange.jfinancials.events.receipt.updated.ReceiptUpdatedEvent;
import org.mxchange.jfinancials.exceptions.receipt.ReceiptAlreadyAddedException;
import org.mxchange.jfinancials.exceptions.receipt.ReceiptNotFoundException;
import org.mxchange.jfinancials.model.receipt.BillableReceipt;
import org.mxchange.jfinancials.model.receipt.FinancialAdminReceiptSessionBeanRemote;
import org.mxchange.jfinancials.model.receipt.FinancialReceipt;
import org.mxchange.jfinancials.model.receipt.Receipts;
import org.mxchange.jproduct.model.payment.PaymentType;
import org.mxchange.jusercore.model.user.User;

/**
 * An administrative backing bean for receipts
 * <p>
 * @author Roland Häder<roland@mxchange.org>
 */
@Named ("adminReceiptActionController")
@ViewScoped
public class FinancialAdminReceiptActionWebViewBean extends BaseFinancialsBean implements FinancialAdminReceiptActionWebViewController {

        /**
         * Serial number
         */
        private static final long serialVersionUID = 595_754_280_374_172L;

        /**
         * Event being fired when administrator has added a new receipt
         */
        @Inject
        @Any
        private Event<ObservableReceiptAddedEvent> adminAddedReceiptEvent;

        /**
         * EJB for general financial receipt purposes
         */
        @EJB (lookup = "java:global/jfinancials-ejb/adminFinancialReceipt!org.mxchange.jfinancials.model.receipt.FinancialAdminReceiptSessionBeanRemote")
        private FinancialAdminReceiptSessionBeanRemote adminReceiptBean;

        /**
         * Event being fired when administrator has added a new receipt
         */
        @Inject
        @Any
        private Event<ObservableReceiptUpdatedEvent> adminUpdatedReceiptEvent;

        /**
         * Current receipt
         */
        private BillableReceipt currentReceipt;

        /**
         * Bar-code number
         */
        private String receiptBarCodeNumber;

        /**
         * Bonus card assigned with receipt
         */
        private BonusCard receiptBonusCard;

        /**
         * Recipient issuing company (for example where the user went shopping to)
         */
        private BranchOffice receiptBranchOffice;

        /**
         * Receipt id number
         */
        private Long receiptId;

        /**
         * Date/time the receipt has been issued
         */
        private Date receiptIssued;

        /**
         * Receipt list controller
         */
        @Inject
        private FinancialsReceiptListWebViewController receiptListController;

        /**
         * Receipt number (only numbers)
         */
        private String receiptNumber;

        /**
         * Payment type being used for this receipt
         */
        private PaymentType receiptPaymentType;

        /**
         * Register number
         */
        private Long receiptRegisterNumber;

        /**
         * Current receipt is a resumption of this receipt
         */
        private BillableReceipt receiptResumptionOf;

        /**
         * Selling employee
         */
        private Employable receiptSellerEmployee;

        /**
         * Sequence number
         */
        private Long receiptSequenceNumber;

        /**
         * Transaction number
         */
        private Long receiptTransactionNumber;

        /**
         * User who "owns" this receipt
         */
        private User receiptUser;

        /**
         * Default constructor
         */
        public FinancialAdminReceiptActionWebViewBean () {
                // Call super constructor
                super();
        }

        /**
         * Adds the completed receipt to database by calling an EJB business method.
         * If not all required fields are set, a proper exception is being thrown.
         * <p>
         */
        public void addReceipt () {
                // Are all required fields set?
                if (this.getReceiptBranchOffice() == null) {
                        // Is not set
                        throw new NullPointerException("this.receiptBranchOffice is not set."); //NOI18N
                } else if (this.getReceiptBranchOffice().getBranchId() == null) {
                        // It must be an already peristed instance
                        throw new NullPointerException("this.receiptBranchOffice.businessContactId is not set."); //NOI18N
                } else if (this.getReceiptBranchOffice().getBranchId() < 1) {
                        // It must be an already peristed instance
                        throw new IllegalArgumentException(MessageFormat.format("this.receiptBranchOffice.businessContactId={0} is not valid.", this.getReceiptBranchOffice().getBranchId())); //NOI18N
                } else if (this.getReceiptPaymentType() == null) {
                        // Is not set
                        throw new NullPointerException("this.receiptPaymentType is not set."); //NOI18N
                } else if (this.getReceiptIssued() == null) {
                        // Is not set
                        throw new NullPointerException("this.receiptIssued is not set."); //NOI18N
                }

                // Prepare receipt instance
                final BillableReceipt receipt = this.createReceiptInstance();

                // Is the receipt already there?
                if (this.receiptListController.isReceiptAdded(receipt)) {
                        // Receipt has already been added
                        throw new FacesException(MessageFormat.format(
                                        "Receipt for receiptBranchOffice={0},receiptIssued={1},receiptNumber={2} has already been added.", //NOI18N
                                        this.getReceiptBranchOffice().getBranchId(),
                                        this.getReceiptIssued().toString(),
                                        this.getReceiptNumber()
                        ));
                }

                // Init variable
                final BillableReceipt updatedReceipt;

                // All is set, then try to call EJB
                try {
                        // Add it
                        updatedReceipt = this.adminReceiptBean.addReceipt(receipt);
                } catch (final ReceiptAlreadyAddedException ex) {
                        // Throw it again
                        throw new FacesException(ex);
                }

                // Fire event with updated instance
                this.adminAddedReceiptEvent.fire(new ReceiptAddedEvent(updatedReceipt));

                // Clear bean
                this.clear();
        }

        /**
         * Copies all fields from current receipt instance to local bean properties.
         */
        public void copyAllReceiptProperties () {
                // Is current receipt instance valid?
                if (this.getCurrentReceipt() == null) {
                        // Not set
                        throw new NullPointerException("this.currentReceipt is null"); //NOI18N
                }

                // Copy all fields
                this.setReceiptBarCodeNumber(this.getCurrentReceipt().getReceiptBarCodeNumber());
                this.setReceiptBonusCard(this.getCurrentReceipt().getReceiptBonusCard());
                this.setReceiptBranchOffice(this.getCurrentReceipt().getReceiptBranchOffice());
                this.setReceiptId(this.getCurrentReceipt().getReceiptId());
                this.setReceiptIssued(this.getCurrentReceipt().getReceiptIssued());
                this.setReceiptNumber(this.getCurrentReceipt().getReceiptNumber());
                this.setReceiptPaymentType(this.getCurrentReceipt().getReceiptPaymentType());
                this.setReceiptRegisterNumber(this.getCurrentReceipt().getReceiptRegisterNumber());
                this.setReceiptSellerEmployee(this.getCurrentReceipt().getReceiptSellerEmployee());
                this.setReceiptSequenceNumber(this.getCurrentReceipt().getReceiptSequenceNumber());
                this.setReceiptTransactionNumber(this.getCurrentReceipt().getReceiptTransactionNumber());
                this.setReceiptUser(this.getCurrentReceipt().getReceiptUser());
        }

        /**
         * Getter for current receipt
         * <p>
         * @return Current receipt
         */
        public BillableReceipt getCurrentReceipt () {
                return this.currentReceipt;
        }

        /**
         * Setter for current receipt
         * <p>
         * @param currentReceipt Current receipt
         */
        public void setCurrentReceipt (final BillableReceipt currentReceipt) {
                this.currentReceipt = currentReceipt;
        }

        /**
         * Getter for receipt's bar-code number
         * <p>
         * @return Receipt's bar-code number
         */
        public String getReceiptBarCodeNumber () {
                return this.receiptBarCodeNumber;
        }

        /**
         * Setter for receipt's bar-code number
         * <p>
         * @param receiptBarCodeNumber Receipt's bar-code number
         */
        public void setReceiptBarCodeNumber (final String receiptBarCodeNumber) {
                this.receiptBarCodeNumber = receiptBarCodeNumber;
        }

        /**
         * Getter for bonus card
         * <p>
         * @return Bonus card
         */
        public BonusCard getReceiptBonusCard () {
                return this.receiptBonusCard;
        }

        /**
         * Setter for bonus card
         * <p>
         * @param receiptBonusCard Bonus card
         */
        public void setReceiptBonusCard (final BonusCard receiptBonusCard) {
                this.receiptBonusCard = receiptBonusCard;
        }

        /**
         * Getter for receipt issuing branch office
         * <p>
         * @return Receipt issuing branch office
         */
        public BranchOffice getReceiptBranchOffice () {
                return this.receiptBranchOffice;
        }

        /**
         * Setter for receipt issuing branch office
         * <p>
         * @param receiptBranchOffice Receipt issuing branch office
         */
        public void setReceiptBranchOffice (final BranchOffice receiptBranchOffice) {
                this.receiptBranchOffice = receiptBranchOffice;
        }

        /**
         * Getter for receipt id
         * <p>
         * @return Receipt it
         */
        public Long getReceiptId () {
                return this.receiptId;
        }

        /**
         * Setter for receipt id
         * <p>
         * @param receiptId Receipt id
         */
        public void setReceiptId (final Long receiptId) {
                this.receiptId = receiptId;
        }

        /**
         * Getter for receipt issue date and time
         * <p>
         * @return Receipt issue date and time
         */
        @SuppressWarnings ("ReturnOfDateField")
        public Date getReceiptIssued () {
                return this.receiptIssued;
        }

        /**
         * Setter for receipt issue date and time
         * <p>
         * @param receiptIssued Receipt issue date and time
         */
        @SuppressWarnings ("AssignmentToDateFieldFromParameter")
        public void setReceiptIssued (final Date receiptIssued) {
                this.receiptIssued = receiptIssued;
        }

        /**
         * Getter for receipt number
         * <p>
         * @return Receipt number
         */
        public String getReceiptNumber () {
                return this.receiptNumber;
        }

        /**
         * Setter for receipt number
         * <p>
         * @param receiptNumber Receipt number
         */
        public void setReceiptNumber (final String receiptNumber) {
                this.receiptNumber = receiptNumber;
        }

        /**
         * Getter for payment type
         * <p>
         * @return Payment type
         */
        public PaymentType getReceiptPaymentType () {
                return this.receiptPaymentType;
        }

        /**
         * Setter for payment type
         * <p>
         * @param receiptPaymentType Payment type
         */
        public void setReceiptPaymentType (final PaymentType receiptPaymentType) {
                this.receiptPaymentType = receiptPaymentType;
        }

        /**
         * Getter for receipt register's number
         * <p>
         * @return Receipt register's number
         */
        public Long getReceiptRegisterNumber () {
                return this.receiptRegisterNumber;
        }

        /**
         * Setter for receipt register's number
         * <p>
         * @param receiptRegisterNumber Receipt register's number
         */
        public void setReceiptRegisterNumber (final Long receiptRegisterNumber) {
                this.receiptRegisterNumber = receiptRegisterNumber;
        }

        /**
         * Getter for receipt's resumption of an other receipt
         * <p>
         * @return Current receipt is based on this receipt
         */
        public BillableReceipt getReceiptResumptionOf () {
                return this.receiptResumptionOf;
        }

        /**
         * Setter for receipt's resumption of an other receipt
         * <p>
         * @param receiptResumptionOf Current receipt is based on this receipt
         */
        public void setReceiptResumptionOf (final BillableReceipt receiptResumptionOf) {
                this.receiptResumptionOf = receiptResumptionOf;
        }

        /**
         * Getter for receipt seller employee
         * <p>
         * @return Receipt seller employee
         */
        public Employable getReceiptSellerEmployee () {
                return this.receiptSellerEmployee;
        }

        /**
         * Setter for receipt seller employee
         * <p>
         * @param receiptSellerEmployee Receipt seller employee
         */
        public void setReceiptSellerEmployee (final Employable receiptSellerEmployee) {
                this.receiptSellerEmployee = receiptSellerEmployee;
        }

        /**
         * Getter for receipt sequence number
         * <p>
         * @return Receipt sequence number
         */
        public Long getReceiptSequenceNumber () {
                return this.receiptSequenceNumber;
        }

        /**
         * Setter for receipt sequence number
         * <p>
         * @param receiptSequenceNumber Receipt sequence number
         */
        public void setReceiptSequenceNumber (final Long receiptSequenceNumber) {
                this.receiptSequenceNumber = receiptSequenceNumber;
        }

        /**
         * Getter for receipt transaction number
         * <p>
         * @return Receipt transaction number
         */
        public Long getReceiptTransactionNumber () {
                return this.receiptTransactionNumber;
        }

        /**
         * Setter for receipt transaction number
         * <p>
         * @param receiptTransactionNumber Receipt transaction number
         */
        public void setReceiptTransactionNumber (final Long receiptTransactionNumber) {
                this.receiptTransactionNumber = receiptTransactionNumber;
        }

        /**
         * Getter for user instance
         * <p>
         * @return User instance
         */
        public User getReceiptUser () {
                return this.receiptUser;
        }

        /**
         * Setter for user instance
         * <p>
         * @param receiptUser User instance
         */
        public void setReceiptUser (final User receiptUser) {
                this.receiptUser = receiptUser;
        }

        /**
         * Updates receipt instance with new data. This copies all fields from this
         * backing bean into currentReceipt instance which should be still there.
         */
        public String updateReceipt () {
                // Is current instance still there?
                if (this.getCurrentReceipt() == null) {
                        // Throw NPE
                        throw new NullPointerException("this.currentReceipt is null"); //NOI18N
                } else if (this.getCurrentReceipt().getReceiptId() == null) {
                        // Throw NPE again
                        throw new NullPointerException("this.currentReceipt.receiptId is null"); //NOI18N
                }

                // Create new instance
                final BillableReceipt receipt = this.createReceiptInstance();

                // Is it the same?
                if (Objects.equals(receipt, this.getCurrentReceipt())) {
                        // Yes, then abort here with message to user
                        this.showFacesMessage("form-edit-receipt", "ADMIN_ERROR_FINANCIAL_RECEIPT_NOT_CHANGED", FacesMessage.SEVERITY_WARN); //NOI18N
                        return ""; //NOI18N
                }

                // Copy all data
                Receipts.copyReceiptData(receipt, this.getCurrentReceipt());

                // Create updated receipt instance
                final BillableReceipt updatedReceipt;

                try {
                        // Invoke EJB method
                        updatedReceipt = this.adminReceiptBean.updateReceipt(this.getCurrentReceipt());
                } catch (final ReceiptNotFoundException ex) {
                        // Throw as cause
                        throw new FacesException(ex);
                }

                // Fire event
                this.adminUpdatedReceiptEvent.fire(new ReceiptUpdatedEvent(updatedReceipt));

                // Clear bean
                this.clear();

                // Redirect to list view
                return "admin_list_receipts"; //NOI18N
        }

        /**
         * Clears this bean
         */
        private void clear () {
                // Clear all fields
                this.setReceiptBarCodeNumber(null);
                this.setReceiptBonusCard(null);
                this.setReceiptBranchOffice(null);
                this.setReceiptId(null);
                this.setReceiptIssued(null);
                this.setReceiptNumber(null);
                this.setReceiptPaymentType(null);
                this.setReceiptRegisterNumber(null);
                this.setReceiptResumptionOf(null);
                this.setReceiptSellerEmployee(null);
                this.setReceiptSequenceNumber(null);
                this.setReceiptTransactionNumber(null);
                this.setReceiptUser(null);
        }

        /**
         * Creates a new instance from all available data of this bean.
         * <p>
         * @return Receipt instance
         */
        private BillableReceipt createReceiptInstance () {
                // Create new instance with minimum required data
                final BillableReceipt receipt = new FinancialReceipt(
                                                          this.getReceiptPaymentType(),
                                                          this.getReceiptBranchOffice(),
                                                          this.getReceiptIssued()
                                          );

                // Set optional data
                receipt.setReceiptBarCodeNumber(this.getReceiptBarCodeNumber());
                receipt.setReceiptBonusCard(this.getReceiptBonusCard());
                receipt.setReceiptId(this.getReceiptId());
                receipt.setReceiptNumber(this.getReceiptNumber());
                receipt.setReceiptRegisterNumber(this.getReceiptRegisterNumber());
                receipt.setReceiptResumptionOf(this.getReceiptResumptionOf());
                receipt.setReceiptSellerEmployee(this.getReceiptSellerEmployee());
                receipt.setReceiptSequenceNumber(this.getReceiptSequenceNumber());
                receipt.setReceiptTransactionNumber(this.getReceiptTransactionNumber());
                receipt.setReceiptUser(this.getReceiptUser());

                // Return prepared instance
                return receipt;
        }

}