001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.CreateGlAccountClassForm;
020import com.echothree.model.control.accounting.server.control.AccountingControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.accounting.server.entity.GlAccountClass;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class CreateGlAccountClassCommand
042        extends BaseSimpleCommand<CreateGlAccountClassForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.GlAccountClass.name(), SecurityRoles.Create.name())
052                        )))
053                )));
054        
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("GlAccountClassName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ParentGlAccountClassName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
059                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
060                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
061                ));
062    }
063    
064    /** Creates a new instance of CreateGlAccountClassCommand */
065    public CreateGlAccountClassCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var accountingControl = Session.getModelController(AccountingControl.class);
072        var glAccountClassName = form.getGlAccountClassName();
073        var glAccountClass = accountingControl.getGlAccountClassByName(glAccountClassName);
074        
075        if(glAccountClass == null) {
076            var parentGlAccountClassName = form.getParentGlAccountClassName();
077            GlAccountClass parentGlAccountClass = null;
078            
079            if(parentGlAccountClassName != null) {
080                parentGlAccountClass = accountingControl.getGlAccountClassByName(parentGlAccountClassName);
081            }
082            
083            if(parentGlAccountClassName == null || parentGlAccountClass != null) {
084                var partyPK = getPartyPK();
085                var isDefault = Boolean.valueOf(form.getIsDefault());
086                var sortOrder = Integer.valueOf(form.getSortOrder());
087                var description = form.getDescription();
088                
089                glAccountClass = accountingControl.createGlAccountClass(glAccountClassName, parentGlAccountClass, isDefault,
090                        sortOrder, partyPK);
091                
092                if(description != null) {
093                    accountingControl.createGlAccountClassDescription(glAccountClass, getPreferredLanguage(), description, partyPK);
094                }
095            } else {
096                addExecutionError(ExecutionErrors.UnknownParentGlAccountClassName.name(), parentGlAccountClassName);
097            }
098        } else {
099            addExecutionError(ExecutionErrors.DuplicateGlAccountClassName.name(), glAccountClassName);
100        }
101        
102        return null;
103    }
104    
105}