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// --------------------------------------------------------------------------------
016
017package com.echothree.control.user.accounting.server.command;
018
019import com.echothree.control.user.accounting.common.form.GetTransactionsForm;
020import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
021import com.echothree.model.control.accounting.server.control.AccountingControl;
022import com.echothree.model.control.accounting.server.logic.TransactionGroupLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.accounting.server.entity.Transaction;
027import com.echothree.model.data.accounting.server.entity.TransactionGroup;
028import com.echothree.model.data.accounting.server.factory.TransactionFactory;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetTransactionsCommand
044        extends BasePaginatedMultipleEntitiesCommand<Transaction, GetTransactionsForm> {
045
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.Transaction.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("TransactionGroupName", FieldType.ENTITY_NAME, false, null, null)
059        );
060    }
061
062    @Inject
063    AccountingControl accountingControl;
064
065    @Inject
066    TransactionGroupLogic transactionGroupLogic;
067
068    
069    /** Creates a new instance of GetTransactionsCommand */
070    public GetTransactionsCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
072    }
073
074    TransactionGroup transactionGroup;
075
076    @Override
077    protected void handleForm() {
078        final var transactionGroupName = form.getTransactionGroupName();
079
080        if(transactionGroupName != null) {
081            transactionGroup = transactionGroupLogic.getTransactionGroupByName(this, transactionGroupName);
082        }
083    }
084
085    @Override
086    protected Long getTotalEntities() {
087        Long totalEntities = null;
088
089        if(!hasExecutionErrors()) {
090            totalEntities = transactionGroup == null ?
091                    accountingControl.countTransactions() :
092                    accountingControl.countTransactionsByTransactionGroup(transactionGroup);
093        }
094
095        return totalEntities;
096    }
097
098    @Override
099    protected Collection<Transaction> getEntities() {
100        Collection<Transaction> entities = null;
101
102        if(!hasExecutionErrors()) {
103            entities = transactionGroup == null ?
104                    accountingControl.getTransactions() :
105                    accountingControl.getTransactionsByTransactionGroup(transactionGroup);
106        }
107
108        return entities;
109    }
110
111    @Override
112    protected BaseResult getResult(final Collection<Transaction> entities) {
113        final var result = AccountingResultFactory.getGetTransactionsResult();
114
115        if(entities != null) {
116            final var userVisit = getUserVisit();
117
118            if(session.hasLimit(TransactionFactory.class)) {
119                result.setTransactionCount(getTotalEntities());
120            }
121
122            if(transactionGroup != null) {
123                result.setTransactionGroup(accountingControl.getTransactionGroupTransfer(userVisit, transactionGroup));
124            }
125
126            result.setTransactions(accountingControl.getTransactionTransfers(userVisit, entities));
127        }
128
129        return result;
130    }
131}