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.edit.AccountingEditFactory;
020import com.echothree.control.user.accounting.common.edit.TransactionGlAccountCategoryDescriptionEdit;
021import com.echothree.control.user.accounting.common.form.EditTransactionGlAccountCategoryDescriptionForm;
022import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
023import com.echothree.control.user.accounting.common.spec.TransactionGlAccountCategoryDescriptionSpec;
024import com.echothree.model.control.accounting.server.control.AccountingControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
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.common.command.EditMode;
035import com.echothree.util.server.control.BaseEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditTransactionGlAccountCategoryDescriptionCommand
045        extends BaseEditCommand<TransactionGlAccountCategoryDescriptionSpec, TransactionGlAccountCategoryDescriptionEdit> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.TransactionGlAccountCategory.name(), SecurityRoles.Description.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("TransactionTypeName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("TransactionGlAccountCategoryName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
063        );
064        
065        EDIT_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
067        );
068    }
069
070    @Inject
071    AccountingControl accountingControl;
072
073    @Inject
074    PartyControl partyControl;
075
076    
077    /** Creates a new instance of EditTransactionGlAccountCategoryDescriptionCommand */
078    public EditTransactionGlAccountCategoryDescriptionCommand() {
079        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
080    }
081    
082    @Override
083    protected BaseResult execute() {
084        var result = AccountingResultFactory.getEditTransactionGlAccountCategoryDescriptionResult();
085        var transactionTypeName = spec.getTransactionTypeName();
086        var transactionType = accountingControl.getTransactionTypeByName(transactionTypeName);
087        
088        if(transactionType != null) {
089            var transactionGlAccountCategoryName = spec.getTransactionGlAccountCategoryName();
090            var transactionGlAccountCategory = accountingControl.getTransactionGlAccountCategoryByName(transactionType, transactionGlAccountCategoryName);
091
092            if(transactionGlAccountCategory != null) {
093                var languageIsoName = spec.getLanguageIsoName();
094                var language = partyControl.getLanguageByIsoName(languageIsoName);
095
096                if(language != null) {
097                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
098                        var transactionGlAccountCategoryDescription = accountingControl.getTransactionGlAccountCategoryDescription(transactionGlAccountCategory, language);
099
100                        if(transactionGlAccountCategoryDescription != null) {
101                            if(editMode.equals(EditMode.LOCK)) {
102                                result.setTransactionGlAccountCategoryDescription(accountingControl.getTransactionGlAccountCategoryDescriptionTransfer(getUserVisit(), transactionGlAccountCategoryDescription));
103
104                                if(lockEntity(transactionGlAccountCategory)) {
105                                    var edit = AccountingEditFactory.getTransactionGlAccountCategoryDescriptionEdit();
106
107                                    result.setEdit(edit);
108                                    edit.setDescription(transactionGlAccountCategoryDescription.getDescription());
109                                } else {
110                                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
111                                }
112
113                                result.setEntityLock(getEntityLockTransfer(transactionGlAccountCategory));
114                            } else { // EditMode.ABANDON
115                                unlockEntity(transactionGlAccountCategory);
116                            }
117                        } else {
118                            addExecutionError(ExecutionErrors.UnknownTransactionGlAccountCategoryDescription.name());
119                        }
120                    } else if(editMode.equals(EditMode.UPDATE)) {
121                        var transactionGlAccountCategoryDescriptionValue = accountingControl.getTransactionGlAccountCategoryDescriptionValueForUpdate(transactionGlAccountCategory, language);
122
123                        if(transactionGlAccountCategoryDescriptionValue != null) {
124                            if(lockEntityForUpdate(transactionGlAccountCategory)) {
125                                try {
126                                    var description = edit.getDescription();
127
128                                    transactionGlAccountCategoryDescriptionValue.setDescription(description);
129
130                                    accountingControl.updateTransactionGlAccountCategoryDescriptionFromValue(transactionGlAccountCategoryDescriptionValue, getPartyPK());
131                                } finally {
132                                    unlockEntity(transactionGlAccountCategory);
133                                }
134                            } else {
135                                addExecutionError(ExecutionErrors.EntityLockStale.name());
136                            }
137                        } else {
138                            addExecutionError(ExecutionErrors.UnknownTransactionGlAccountCategoryDescription.name());
139                        }
140                    }
141                } else {
142                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
143                }
144            } else {
145                addExecutionError(ExecutionErrors.UnknownTransactionGlAccountCategoryName.name(), transactionGlAccountCategoryName);
146            }
147        } else {
148            addExecutionError(ExecutionErrors.UnknownTransactionTypeName.name(), transactionTypeName);
149        }
150        
151        return result;
152    }
153    
154}