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.DeleteTransactionGlAccountCategoryDescriptionForm;
020import com.echothree.model.control.accounting.server.control.AccountingControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.accounting.server.entity.TransactionGlAccountCategory;
026import com.echothree.model.data.accounting.server.entity.TransactionGlAccountCategoryDescription;
027import com.echothree.model.data.accounting.server.entity.TransactionType;
028import com.echothree.model.data.party.server.entity.Language;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class DeleteTransactionGlAccountCategoryDescriptionCommand
044        extends BaseSimpleCommand<DeleteTransactionGlAccountCategoryDescriptionForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.TransactionGlAccountCategory.name(), SecurityRoles.Description.name())
054                        )))
055                )));
056        
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("TransactionTypeName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("TransactionGlAccountCategoryName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of DeleteTransactionGlAccountCategoryDescriptionCommand */
065    public DeleteTransactionGlAccountCategoryDescriptionCommand(UserVisitPK userVisitPK, DeleteTransactionGlAccountCategoryDescriptionForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var accountingControl = Session.getModelController(AccountingControl.class);
072        String transactionTypeName = form.getTransactionTypeName();
073        TransactionType transactionType = accountingControl.getTransactionTypeByName(transactionTypeName);
074        
075        if(transactionType != null) {
076            String transactionGlAccountCategoryName = form.getTransactionGlAccountCategoryName();
077            TransactionGlAccountCategory transactionGlAccountCategory = accountingControl.getTransactionGlAccountCategoryByName(transactionType, transactionGlAccountCategoryName);
078
079            if(transactionGlAccountCategory != null) {
080                var partyControl = Session.getModelController(PartyControl.class);
081                String languageIsoName = form.getLanguageIsoName();
082                Language language = partyControl.getLanguageByIsoName(languageIsoName);
083
084                if(language != null) {
085                    TransactionGlAccountCategoryDescription transactionGlAccountCategoryDescription = accountingControl.getTransactionGlAccountCategoryDescriptionForUpdate(transactionGlAccountCategory, language);
086
087                    if(transactionGlAccountCategoryDescription != null) {
088                        accountingControl.deleteTransactionGlAccountCategoryDescription(transactionGlAccountCategoryDescription, getPartyPK());
089                    } else {
090                        addExecutionError(ExecutionErrors.UnknownTransactionGlAccountCategoryDescription.name());
091                    }
092                } else {
093                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
094                }
095            } else {
096                addExecutionError(ExecutionErrors.UnknownTransactionGlAccountCategoryName.name(), transactionGlAccountCategoryName);
097            }
098        } else {
099            addExecutionError(ExecutionErrors.UnknownTransactionTypeName.name(), transactionTypeName);
100        }
101        
102        return null;
103    }
104    
105}