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.GetGlAccountChoicesForm;
020import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
021import com.echothree.model.control.accounting.common.choice.GlAccountChoicesBean;
022import com.echothree.model.control.accounting.server.control.AccountingControl;
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.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetGlAccountChoicesCommand
041        extends BaseSimpleCommand<GetGlAccountChoicesForm> {
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.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.GlAccount.name(), SecurityRoles.Choices.name())
050                        ))
051                ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("GlAccountCategoryName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("DefaultGlAccountChoice", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
057                );
058    }
059    
060    /** Creates a new instance of GetGlAccountChoicesCommand */
061    public GetGlAccountChoicesCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var accountingControl = Session.getModelController(AccountingControl.class);
068        var result = AccountingResultFactory.getGetGlAccountChoicesResult();
069        var glAccountCategoryName = form.getGlAccountCategoryName();
070        var glAccountCategory = glAccountCategoryName == null? null: accountingControl.getGlAccountCategoryByName(glAccountCategoryName);
071        
072        if(glAccountCategoryName == null || glAccountCategory != null) {
073            var defaultGlAccountChoice = form.getDefaultGlAccountChoice();
074            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
075            GlAccountChoicesBean glAccountChoicesBean;
076            
077            if(glAccountCategory != null) {
078                glAccountChoicesBean = accountingControl.getGlAccountChoicesByGlAccountCategory(defaultGlAccountChoice,
079                        getPreferredLanguage(), glAccountCategory, allowNullChoice);
080            } else {
081                glAccountChoicesBean = accountingControl.getGlAccountChoices(defaultGlAccountChoice, getPreferredLanguage(),
082                        allowNullChoice);
083            }
084            
085            result.setGlAccountChoices(glAccountChoicesBean);
086        } else {
087            addExecutionError(ExecutionErrors.UnknownGlAccountCategoryName.name(), glAccountCategoryName);
088        }
089        
090        return result;
091    }
092    
093}