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// --------------------------------------------------------------------------------
016package com.echothree.model.control.accounting.server.transfer;
017
018import com.echothree.model.control.accounting.common.AccountingOptions;
019import com.echothree.model.control.accounting.common.transfer.TransactionTimeTransfer;
020import com.echothree.model.control.accounting.common.transfer.TransactionTransfer;
021import com.echothree.model.control.accounting.common.workflow.TransactionStatusConstants;
022import com.echothree.model.control.accounting.server.control.AccountingControl;
023import com.echothree.model.control.accounting.server.control.TransactionTimeControl;
024import com.echothree.model.control.core.server.control.EntityInstanceControl;
025import com.echothree.model.control.party.server.control.PartyControl;
026import com.echothree.model.control.workflow.server.control.WorkflowControl;
027import com.echothree.model.data.accounting.server.entity.Transaction;
028import com.echothree.model.data.user.server.entity.UserVisit;
029import com.echothree.util.common.transfer.ListWrapper;
030import com.echothree.util.common.transfer.MapWrapper;
031import com.echothree.util.server.persistence.Session;
032import javax.enterprise.context.RequestScoped;
033
034@RequestScoped
035public class TransactionTransferCache
036        extends BaseAccountingTransferCache<Transaction, TransactionTransfer> {
037
038    AccountingControl accountingControl = Session.getModelController(AccountingControl.class);
039    EntityInstanceControl entityInstanceControl = Session.getModelController(EntityInstanceControl.class);
040    PartyControl partyControl = Session.getModelController(PartyControl.class);
041    TransactionTimeControl transactionTimeControl = Session.getModelController(TransactionTimeControl.class);
042    WorkflowControl workflowControl = Session.getModelController(WorkflowControl.class);
043
044    boolean includeTransactionGlEntries;
045    boolean includeTransactionEntityRoles;
046    boolean includeTransactionTimes;
047
048    /** Creates a new instance of TransactionTransferCache */
049    protected TransactionTransferCache() {
050        super();
051        
052        var options = session.getOptions();
053        if(options != null) {
054            includeTransactionGlEntries = options.contains(AccountingOptions.TransactionIncludeTransactionGlEntries);
055            includeTransactionEntityRoles = options.contains(AccountingOptions.TransactionIncludeTransactionEntityRoles);
056            includeTransactionTimes = options.contains(AccountingOptions.TransactionIncludeTransactionTimes);
057        }
058        
059        setIncludeEntityInstance(true);
060    }
061
062    @Override
063    public TransactionTransfer getTransfer(UserVisit userVisit, Transaction transaction) {
064        var transactionTransfer = get(transaction);
065
066        if(transactionTransfer == null) {
067            var transactionDetail = transaction.getLastDetail();
068            var transactionName = transactionDetail.getTransactionName();
069            var groupParty = transactionDetail.getGroupParty();
070            var groupPartyTransfer = groupParty == null? null: partyControl.getPartyTransfer(userVisit, groupParty);
071            var transactionGroupTransfer = accountingControl.getTransactionGroupTransfer(userVisit, transactionDetail.getTransactionGroup());
072            var transactionTypeTransfer = accountingControl.getTransactionTypeTransfer(userVisit, transactionDetail.getTransactionType());
073
074            var entityInstance = entityInstanceControl.getEntityInstanceByBasePK(transaction.getPrimaryKey());
075            var transactionStatusTransfer = workflowControl.getWorkflowEntityStatusTransferByEntityInstanceUsingNames(userVisit,
076                    TransactionStatusConstants.Workflow_TRANSACTION_STATUS, entityInstance);
077
078            transactionTransfer = new TransactionTransfer(transactionName, groupPartyTransfer, transactionGroupTransfer,
079                    transactionTypeTransfer, transactionStatusTransfer);
080            put(userVisit, transaction, transactionTransfer);
081            
082            if(includeTransactionGlEntries) {
083                transactionTransfer.setTransactionGlEntries(new ListWrapper<>(accountingControl.getTransactionGlEntryTransfersByTransaction(userVisit, transaction)));
084            }
085
086            if(includeTransactionEntityRoles) {
087                transactionTransfer.setTransactionEntityRoles(new ListWrapper<>(accountingControl.getTransactionEntityRoleTransfersByTransaction(userVisit, transaction)));
088            }
089
090            if(includeTransactionTimes) {
091                var transfers = transactionTimeControl.getTransactionTimeTransfersByTransaction(userVisit, transaction);
092                var mapWrapper = new MapWrapper<TransactionTimeTransfer>(transfers.size());
093
094                transfers.forEach((transfer) -> {
095                    mapWrapper.put(transfer.getTransactionTimeType().getTransactionTimeTypeName(), transfer);
096                });
097
098                transactionTransfer.setTransactionTimes(mapWrapper);
099            }
100        }
101
102        return transactionTransfer;
103    }
104
105}