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.CreateTransactionGlAccountCategoryForm;
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.GlAccount;
025import com.echothree.model.data.accounting.server.entity.GlAccountCategory;
026import com.echothree.model.data.accounting.server.entity.TransactionGlAccountCategory;
027import com.echothree.model.data.accounting.server.entity.TransactionType;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class CreateTransactionGlAccountCategoryCommand
043        extends BaseSimpleCommand<CreateTransactionGlAccountCategoryForm> {
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(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.TransactionGlAccountCategory.name(), SecurityRoles.Create.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("TransactionTypeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("TransactionGlAccountCategoryName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("GlAccountCategoryName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
061                new FieldDefinition("GlAccountName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
063                ));
064    }
065    
066    /** Creates a new instance of CreateTransactionGlAccountCategoryCommand */
067    public CreateTransactionGlAccountCategoryCommand(UserVisitPK userVisitPK, CreateTransactionGlAccountCategoryForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var accountingControl = Session.getModelController(AccountingControl.class);
074        String transactionTypeName = form.getTransactionTypeName();
075        TransactionType transactionType = accountingControl.getTransactionTypeByName(transactionTypeName);
076        
077        if(transactionType != null) {
078            String transactionGlAccountCategoryName = form.getTransactionGlAccountCategoryName();
079            TransactionGlAccountCategory transactionGlAccountCategory = accountingControl.getTransactionGlAccountCategoryByName(transactionType, transactionGlAccountCategoryName);
080            
081            if(transactionGlAccountCategory == null) {
082                String glAccountCategoryName = form.getGlAccountCategoryName();
083                GlAccountCategory glAccountCategory = glAccountCategoryName == null? null: accountingControl.getGlAccountCategoryByName(glAccountCategoryName);
084                
085                if(glAccountCategoryName == null || glAccountCategory != null) {
086                    String glAccountName = form.getGlAccountName();
087                    GlAccount glAccount = glAccountName == null? null: accountingControl.getGlAccountByName(glAccountName);
088
089                    if(glAccountName == null || glAccount != null) {
090                        if(glAccountCategory == null || glAccount == null? true: glAccountCategory.equals(glAccount.getLastDetail().getGlAccountCategory())) {
091                            var sortOrder = Integer.valueOf(form.getSortOrder());
092                            var description = form.getDescription();
093                            var partyPK = getPartyPK();
094
095                            transactionGlAccountCategory = accountingControl.createTransactionGlAccountCategory(transactionType, transactionGlAccountCategoryName, glAccountCategory, sortOrder, partyPK);
096                            
097                            if(glAccount != null) {
098                                accountingControl.createTransactionGlAccount(transactionGlAccountCategory, glAccount, partyPK);
099                            }
100                            
101                            if(description != null) {
102                                accountingControl.createTransactionGlAccountCategoryDescription(transactionGlAccountCategory, getPreferredLanguage(), description, partyPK);
103                            }
104                        } else {
105                            addExecutionError(ExecutionErrors.InvalidGlAccountCategory.name());
106                        }
107                    } else {
108                        addExecutionError(ExecutionErrors.UnknownGlAccountName.name(), glAccountName);
109                    }
110                } else {
111                    addExecutionError(ExecutionErrors.UnknownGlAccountCategoryName.name(), glAccountCategoryName);
112                }
113            } else {
114                addExecutionError(ExecutionErrors.DuplicateTransactionGlAccountCategoryName.name(), transactionGlAccountCategoryName);
115            }
116        } else {
117            addExecutionError(ExecutionErrors.UnknownTransactionTypeName.name(), transactionTypeName);
118        }
119        
120        return null;
121    }
122    
123}