001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.model.control.invoice.server.transfer;
018
019import com.echothree.model.control.accounting.server.control.AccountingControl;
020import com.echothree.model.control.core.server.control.EntityInstanceControl;
021import com.echothree.model.control.invoice.common.InvoiceOptions;
022import com.echothree.model.control.invoice.common.InvoiceTypes;
023import com.echothree.model.control.invoice.common.transfer.InvoiceRoleTransfer;
024import com.echothree.model.control.invoice.common.transfer.InvoiceTimeTransfer;
025import com.echothree.model.control.invoice.common.transfer.InvoiceTransfer;
026import com.echothree.model.control.invoice.common.workflow.PurchaseInvoiceStatusConstants;
027import com.echothree.model.control.invoice.server.control.InvoiceControl;
028import com.echothree.model.control.payment.server.control.BillingControl;
029import com.echothree.model.control.term.server.control.TermControl;
030import com.echothree.model.control.workflow.common.transfer.WorkflowEntityStatusTransfer;
031import com.echothree.model.control.workflow.server.control.WorkflowControl;
032import com.echothree.model.data.invoice.server.entity.Invoice;
033import com.echothree.model.data.user.server.entity.UserVisit;
034import com.echothree.util.common.transfer.ListWrapper;
035import com.echothree.util.common.transfer.MapWrapper;
036import com.echothree.util.server.persistence.Session;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class InvoiceTransferCache
041        extends BaseInvoiceTransferCache<Invoice, InvoiceTransfer> {
042    
043    AccountingControl accountingControl = Session.getModelController(AccountingControl.class);
044    BillingControl billingControl = Session.getModelController(BillingControl.class);
045    EntityInstanceControl entityInstanceControl = Session.getModelController(EntityInstanceControl.class);
046    InvoiceControl invoiceControl = Session.getModelController(InvoiceControl.class);
047    TermControl termControl = Session.getModelController(TermControl.class);
048    WorkflowControl workflowControl = Session.getModelController(WorkflowControl.class);
049    boolean includeLines;
050    boolean includeRoles;
051
052    /** Creates a new instance of InvoiceTransferCache */
053    protected InvoiceTransferCache() {
054        super();
055
056        var options = session.getOptions();
057        if(options != null) {
058            includeLines = options.contains(InvoiceOptions.InvoiceIncludeLines);
059            includeRoles = options.contains(InvoiceOptions.InvoiceIncludeRoles);
060        }
061
062        setIncludeEntityInstance(true);
063    }
064
065    private InvoiceTransfer setInvoiceTimes(UserVisit userVisit, Invoice invoice, InvoiceTransfer invoiceTransfer) {
066        var invoiceTimeTransfers = invoiceControl.getInvoiceTimeTransfersByInvoice(userVisit, invoice);
067        var invoiceTimes = new MapWrapper<InvoiceTimeTransfer>(invoiceTimeTransfers.size());
068
069        invoiceTimeTransfers.forEach((invoiceTimeTransfer) -> {
070            invoiceTimes.put(invoiceTimeTransfer.getInvoiceTimeType().getInvoiceTimeTypeName(), invoiceTimeTransfer);
071        });
072
073        invoiceTransfer.setInvoiceTimes(invoiceTimes);
074
075        return invoiceTransfer;
076    }
077
078    private InvoiceTransfer setInvoiceRoles(UserVisit userVisit, Invoice invoice, InvoiceTransfer invoiceTransfer) {
079        var invoiceRoleTransfers = invoiceControl.getInvoiceRoleTransfersByInvoice(userVisit, invoice);
080        var invoiceRoles = new MapWrapper<InvoiceRoleTransfer>(invoiceRoleTransfers.size());
081
082        invoiceRoleTransfers.forEach((invoiceRoleTransfer) -> {
083            invoiceRoles.put(invoiceRoleTransfer.getInvoiceRoleType().getInvoiceRoleTypeUseTypeName(), invoiceRoleTransfer);
084        });
085
086        invoiceTransfer.setInvoiceRoles(invoiceRoles);
087
088        return invoiceTransfer;
089    }
090
091    public InvoiceTransfer getInvoiceTransfer(UserVisit userVisit, Invoice invoice) {
092        var invoiceTransfer = get(invoice);
093        
094        if(invoiceTransfer == null) {
095            var invoiceDetail = invoice.getLastDetail();
096            var invoiceType = invoiceControl.getInvoiceTypeTransfer(userVisit, invoiceDetail.getInvoiceType());
097            var invoiceName = invoiceDetail.getInvoiceName();
098            var billingAccount = billingControl.getBillingAccountTransfer(userVisit, invoiceDetail.getBillingAccount());
099            var glAccount = accountingControl.getGlAccountTransfer(userVisit, invoiceDetail.getGlAccount());
100            var term = termControl.getTermTransfer(userVisit, invoiceDetail.getTerm());
101            var reference = invoiceDetail.getReference();
102            var description = invoiceDetail.getDescription();
103            WorkflowEntityStatusTransfer invoiceStatus = null;
104
105            var invoiceTypeName = invoiceType.getInvoiceTypeName();
106            var entityInstance = entityInstanceControl.getEntityInstanceByBasePK(invoice.getPrimaryKey());
107            if(invoiceTypeName.equals(InvoiceTypes.PURCHASE_INVOICE.name())) {
108                invoiceStatus = workflowControl.getWorkflowEntityStatusTransferByEntityInstanceUsingNames(userVisit, PurchaseInvoiceStatusConstants.Workflow_PURCHASE_INVOICE_STATUS, entityInstance);
109            }
110            
111            invoiceTransfer = setInvoiceTimes(userVisit, invoice, new InvoiceTransfer(invoiceType, invoiceName, billingAccount, glAccount, term, reference, description, invoiceStatus));
112            put(userVisit, invoice, invoiceTransfer, entityInstance);
113
114            if(includeLines) {
115                invoiceTransfer.setInvoiceLines(new ListWrapper<>(invoiceControl.getInvoiceLineTransfersByInvoice(userVisit, invoice)));
116            }
117
118            if(includeRoles) {
119                setInvoiceRoles(userVisit, invoice, invoiceTransfer);
120            }
121        }
122        
123        return invoiceTransfer;
124    }
125    
126}