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