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 com.echothree.util.server.persistence.Session;
040import java.util.List;
041import javax.enterprise.context.Dependent;
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    /** Creates a new instance of EditTransactionGlAccountCategoryDescriptionCommand */
071    public EditTransactionGlAccountCategoryDescriptionCommand() {
072        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
073    }
074    
075    @Override
076    protected BaseResult execute() {
077        var accountingControl = Session.getModelController(AccountingControl.class);
078        var result = AccountingResultFactory.getEditTransactionGlAccountCategoryDescriptionResult();
079        var transactionTypeName = spec.getTransactionTypeName();
080        var transactionType = accountingControl.getTransactionTypeByName(transactionTypeName);
081        
082        if(transactionType != null) {
083            var transactionGlAccountCategoryName = spec.getTransactionGlAccountCategoryName();
084            var transactionGlAccountCategory = accountingControl.getTransactionGlAccountCategoryByName(transactionType, transactionGlAccountCategoryName);
085
086            if(transactionGlAccountCategory != null) {
087                var partyControl = Session.getModelController(PartyControl.class);
088                var languageIsoName = spec.getLanguageIsoName();
089                var language = partyControl.getLanguageByIsoName(languageIsoName);
090
091                if(language != null) {
092                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093                        var transactionGlAccountCategoryDescription = accountingControl.getTransactionGlAccountCategoryDescription(transactionGlAccountCategory, language);
094
095                        if(transactionGlAccountCategoryDescription != null) {
096                            if(editMode.equals(EditMode.LOCK)) {
097                                result.setTransactionGlAccountCategoryDescription(accountingControl.getTransactionGlAccountCategoryDescriptionTransfer(getUserVisit(), transactionGlAccountCategoryDescription));
098
099                                if(lockEntity(transactionGlAccountCategory)) {
100                                    var edit = AccountingEditFactory.getTransactionGlAccountCategoryDescriptionEdit();
101
102                                    result.setEdit(edit);
103                                    edit.setDescription(transactionGlAccountCategoryDescription.getDescription());
104                                } else {
105                                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
106                                }
107
108                                result.setEntityLock(getEntityLockTransfer(transactionGlAccountCategory));
109                            } else { // EditMode.ABANDON
110                                unlockEntity(transactionGlAccountCategory);
111                            }
112                        } else {
113                            addExecutionError(ExecutionErrors.UnknownTransactionGlAccountCategoryDescription.name());
114                        }
115                    } else if(editMode.equals(EditMode.UPDATE)) {
116                        var transactionGlAccountCategoryDescriptionValue = accountingControl.getTransactionGlAccountCategoryDescriptionValueForUpdate(transactionGlAccountCategory, language);
117
118                        if(transactionGlAccountCategoryDescriptionValue != null) {
119                            if(lockEntityForUpdate(transactionGlAccountCategory)) {
120                                try {
121                                    var description = edit.getDescription();
122
123                                    transactionGlAccountCategoryDescriptionValue.setDescription(description);
124
125                                    accountingControl.updateTransactionGlAccountCategoryDescriptionFromValue(transactionGlAccountCategoryDescriptionValue, getPartyPK());
126                                } finally {
127                                    unlockEntity(transactionGlAccountCategory);
128                                }
129                            } else {
130                                addExecutionError(ExecutionErrors.EntityLockStale.name());
131                            }
132                        } else {
133                            addExecutionError(ExecutionErrors.UnknownTransactionGlAccountCategoryDescription.name());
134                        }
135                    }
136                } else {
137                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
138                }
139            } else {
140                addExecutionError(ExecutionErrors.UnknownTransactionGlAccountCategoryName.name(), transactionGlAccountCategoryName);
141            }
142        } else {
143            addExecutionError(ExecutionErrors.UnknownTransactionTypeName.name(), transactionTypeName);
144        }
145        
146        return result;
147    }
148    
149}