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.GetGlAccountsForm;
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.GlAccountCategoryLogic;
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.GlAccount;
027import com.echothree.model.data.accounting.server.entity.GlAccountCategory;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetGlAccountsCommand
043        extends BasePaginatedMultipleEntitiesCommand<GlAccount, GetGlAccountsForm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.GlAccount.name(), SecurityRoles.List.name())
053                ))
054        ));
055        
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("GlAccountCategoryName", FieldType.ENTITY_NAME, false, null, null)
058        );
059    }
060
061    @Inject
062    AccountingControl accountingControl;
063
064    @Inject
065    GlAccountCategoryLogic glAccountCategoryLogic;
066
067    
068    /** Creates a new instance of GetGlAccountsCommand */
069    public GetGlAccountsCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
071    }
072
073    GlAccountCategory glAccountCategory = null;
074
075    @Override
076    protected void handleForm() {
077        var glAccountCategoryName = form.getGlAccountCategoryName();
078
079        if(glAccountCategoryName != null) {
080            glAccountCategory = glAccountCategoryLogic.getGlAccountCategoryByName(this, glAccountCategoryName);
081        }
082    }
083
084    @Override
085    protected Long getTotalEntities() {
086        return hasExecutionErrors() ? null :
087                glAccountCategory == null ?
088                        accountingControl.countGlAccounts() :
089                        accountingControl.countGlAccountsByGlAccountCategory(glAccountCategory);
090    }
091
092    @Override
093    protected Collection<GlAccount> getEntities() {
094        Collection<GlAccount> glAccounts = null;
095
096        if(!hasExecutionErrors()) {
097            glAccounts = glAccountCategory == null ?
098                    accountingControl.getGlAccounts() :
099                    accountingControl.getGlAccountsByGlAccountCategory(glAccountCategory);
100        }
101
102        return glAccounts;
103    }
104
105    @Override
106    protected BaseResult getResult(Collection<GlAccount> entities) {
107        var result = AccountingResultFactory.getGetGlAccountsResult();
108
109        if(entities != null) {
110            if(glAccountCategory == null) {
111                result.setGlAccountCount(accountingControl.countGlAccounts());
112                result.setGlAccounts(accountingControl.getGlAccountTransfers(getUserVisit(), entities));
113            } else {
114                var userVisit = getUserVisit();
115
116                result.setGlAccountCount(accountingControl.countGlAccountsByGlAccountCategory(glAccountCategory));
117                result.setGlAccountCategory(accountingControl.getGlAccountCategoryTransfer(userVisit, glAccountCategory));
118                result.setGlAccounts(accountingControl.getGlAccountTransfers(userVisit, entities));
119            }
120        }
121
122        return result;
123    }
124
125}