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