001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.common.transfer.GlAccountTransfer;
020import com.echothree.model.control.accounting.server.control.AccountingControl;
021import com.echothree.model.control.core.server.control.CoreControl;
022import com.echothree.model.control.invoice.common.InvoiceOptions;
023import com.echothree.model.control.invoice.common.InvoiceTypes;
024import com.echothree.model.control.invoice.common.transfer.InvoiceRoleTransfer;
025import com.echothree.model.control.invoice.common.transfer.InvoiceTimeTransfer;
026import com.echothree.model.control.invoice.common.transfer.InvoiceTransfer;
027import com.echothree.model.control.invoice.common.transfer.InvoiceTypeTransfer;
028import com.echothree.model.control.invoice.common.workflow.PurchaseInvoiceStatusConstants;
029import com.echothree.model.control.invoice.server.control.InvoiceControl;
030import com.echothree.model.control.payment.common.transfer.BillingAccountTransfer;
031import com.echothree.model.control.payment.server.control.BillingControl;
032import com.echothree.model.control.term.common.transfer.TermTransfer;
033import com.echothree.model.control.term.server.control.TermControl;
034import com.echothree.model.control.workflow.common.transfer.WorkflowEntityStatusTransfer;
035import com.echothree.model.control.workflow.server.control.WorkflowControl;
036import com.echothree.model.data.core.server.entity.EntityInstance;
037import com.echothree.model.data.invoice.server.entity.Invoice;
038import com.echothree.model.data.invoice.server.entity.InvoiceDetail;
039import com.echothree.model.data.user.server.entity.UserVisit;
040import com.echothree.util.common.string.DateTimeFormatType;
041import com.echothree.util.common.string.DateTimeFormatter;
042import com.echothree.util.common.transfer.ListWrapper;
043import com.echothree.util.common.transfer.MapWrapper;
044import com.echothree.util.server.persistence.Session;
045import com.echothree.util.server.string.DateUtils;
046import java.util.List;
047import java.util.Set;
048
049public class InvoiceTransferCache
050        extends BaseInvoiceTransferCache<Invoice, InvoiceTransfer> {
051    
052    AccountingControl accountingControl = Session.getModelController(AccountingControl.class);
053    BillingControl billingControl = Session.getModelController(BillingControl.class);
054    CoreControl coreControl = Session.getModelController(CoreControl.class);
055    TermControl termControl = Session.getModelController(TermControl.class);
056    WorkflowControl workflowControl = Session.getModelController(WorkflowControl.class);
057    boolean includeLines;
058    boolean includeRoles;
059    DateTimeFormatter shortDateFormatter;
060    
061    /** Creates a new instance of InvoiceTransferCache */
062    public InvoiceTransferCache(UserVisit userVisit, InvoiceControl invoiceControl) {
063        super(userVisit, invoiceControl);
064
065        var options = session.getOptions();
066        if(options != null) {
067            includeLines = options.contains(InvoiceOptions.InvoiceIncludeLines);
068            includeRoles = options.contains(InvoiceOptions.InvoiceIncludeRoles);
069        }
070
071        setIncludeEntityInstance(true);
072        
073        shortDateFormatter = DateUtils.getInstance().getDateTimeFormatter(userVisit, DateTimeFormatType.SHORT_DATE);
074    }
075
076    private InvoiceTransfer setInvoiceTimes(Invoice invoice, InvoiceTransfer invoiceTransfer) {
077        List<InvoiceTimeTransfer> invoiceTimeTransfers = invoiceControl.getInvoiceTimeTransfersByInvoice(userVisit, invoice);
078        MapWrapper<InvoiceTimeTransfer> invoiceTimes = new MapWrapper<>(invoiceTimeTransfers.size());
079
080        invoiceTimeTransfers.forEach((invoiceTimeTransfer) -> {
081            invoiceTimes.put(invoiceTimeTransfer.getInvoiceTimeType().getInvoiceTimeTypeName(), invoiceTimeTransfer);
082        });
083
084        invoiceTransfer.setInvoiceTimes(invoiceTimes);
085
086        return invoiceTransfer;
087    }
088
089    private InvoiceTransfer setInvoiceRoles(Invoice invoice, InvoiceTransfer invoiceTransfer) {
090        List<InvoiceRoleTransfer> invoiceRoleTransfers = invoiceControl.getInvoiceRoleTransfersByInvoice(userVisit, invoice);
091        MapWrapper<InvoiceRoleTransfer> invoiceRoles = new MapWrapper<>(invoiceRoleTransfers.size());
092
093        invoiceRoleTransfers.forEach((invoiceRoleTransfer) -> {
094            invoiceRoles.put(invoiceRoleTransfer.getInvoiceRoleType().getInvoiceRoleTypeUseTypeName(), invoiceRoleTransfer);
095        });
096
097        invoiceTransfer.setInvoiceRoles(invoiceRoles);
098
099        return invoiceTransfer;
100    }
101
102    public InvoiceTransfer getInvoiceTransfer(Invoice invoice) {
103        InvoiceTransfer invoiceTransfer = get(invoice);
104        
105        if(invoiceTransfer == null) {
106            InvoiceDetail invoiceDetail = invoice.getLastDetail();
107            InvoiceTypeTransfer invoiceType = invoiceControl.getInvoiceTypeTransfer(userVisit, invoiceDetail.getInvoiceType());
108            String invoiceName = invoiceDetail.getInvoiceName();
109            BillingAccountTransfer billingAccount = billingControl.getBillingAccountTransfer(userVisit, invoiceDetail.getBillingAccount());
110            GlAccountTransfer glAccount = accountingControl.getGlAccountTransfer(userVisit, invoiceDetail.getGlAccount());
111            TermTransfer term = termControl.getTermTransfer(userVisit, invoiceDetail.getTerm()); 
112            String reference = invoiceDetail.getReference();
113            String description = invoiceDetail.getDescription();
114            WorkflowEntityStatusTransfer invoiceStatus = null;
115            
116            String invoiceTypeName = invoiceType.getInvoiceTypeName();
117            EntityInstance entityInstance = coreControl.getEntityInstanceByBasePK(invoice.getPrimaryKey());
118            if(invoiceTypeName.equals(InvoiceTypes.PURCHASE_INVOICE.name())) {
119                invoiceStatus = workflowControl.getWorkflowEntityStatusTransferByEntityInstanceUsingNames(userVisit, PurchaseInvoiceStatusConstants.Workflow_PURCHASE_INVOICE_STATUS, entityInstance);
120            }
121            
122            invoiceTransfer = setInvoiceTimes(invoice, new InvoiceTransfer(invoiceType, invoiceName, billingAccount, glAccount, term, reference, description, invoiceStatus));
123            put(invoice, invoiceTransfer, entityInstance);
124            
125
126            if(includeLines) {
127                invoiceTransfer.setInvoiceLines(new ListWrapper<>(invoiceControl.getInvoiceLineTransfersByInvoice(userVisit, invoice)));
128            }
129
130            if(includeRoles) {
131                setInvoiceRoles(invoice, invoiceTransfer);
132            }
133        }
134        
135        return invoiceTransfer;
136    }
137    
138}