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.GetTransactionGlAccountCategoriesForm;
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.TransactionTypeLogic;
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.TransactionGlAccountCategory;
027import com.echothree.model.data.accounting.server.entity.TransactionType;
028import com.echothree.model.data.accounting.server.factory.TransactionTypeFactory;
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 GetTransactionGlAccountCategoriesCommand
044        extends BasePaginatedMultipleEntitiesCommand<TransactionGlAccountCategory, GetTransactionGlAccountCategoriesForm> {
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.TransactionGlAccountCategory.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("TransactionTypeName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    AccountingControl accountingControl;
064
065    @Inject
066    TransactionTypeLogic transactionTypeLogic;
067
068    
069    /** Creates a new instance of GetTransactionGlAccountCategoriesCommand */
070    public GetTransactionGlAccountCategoriesCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
072    }
073
074    TransactionType transactionType;
075
076    @Override
077    protected void handleForm() {
078        transactionType = transactionTypeLogic.getTransactionTypeByName(this, form.getTransactionTypeName());
079    }
080
081    @Override
082    protected Long getTotalEntities() {
083        Long totalEntities = null;
084
085        if(!hasExecutionErrors()) {
086            totalEntities = accountingControl.countTransactionGlAccountCategoriesByTransactionType(transactionType);
087        }
088
089        return totalEntities;
090    }
091
092    @Override
093    protected Collection<TransactionGlAccountCategory> getEntities() {
094        Collection<TransactionGlAccountCategory> entities = null;
095
096        if(!hasExecutionErrors()) {
097            entities = accountingControl.getTransactionGlAccountCategoriesByTransactionType(transactionType);
098        }
099
100        return entities;
101    }
102
103    @Override
104    protected BaseResult getResult(Collection<TransactionGlAccountCategory> entities) {
105        var result = AccountingResultFactory.getGetTransactionGlAccountCategoriesResult();
106
107        if(entities != null) {
108            var userVisit = getUserVisit();
109
110            result.setTransactionType(accountingControl.getTransactionTypeTransfer(userVisit, transactionType));
111
112            if(session.hasLimit(TransactionTypeFactory.class)) {
113                result.setTransactionGlAccountCategoryCount(getTotalEntities());
114            }
115
116            result.setTransactionGlAccountCategories(accountingControl.getTransactionGlAccountCategoryTransfers(userVisit, entities));
117        }
118
119        return result;
120    }
121
122}