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.GlAccountClassEdit;
021import com.echothree.control.user.accounting.common.form.EditGlAccountClassForm;
022import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
023import com.echothree.control.user.accounting.common.spec.GlAccountClassSpec;
024import com.echothree.model.control.accounting.server.control.AccountingControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.accounting.server.entity.GlAccountClass;
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 EditGlAccountClassCommand
045        extends BaseEditCommand<GlAccountClassSpec, GlAccountClassEdit> {
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.GlAccountClass.name(), SecurityRoles.Edit.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("GlAccountClassName", FieldType.ENTITY_NAME, true, null, null)
061        );
062        
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("GlAccountClassName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("ParentGlAccountClassName", FieldType.ENTITY_NAME, false, null, null),
066                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
067                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
068                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
069        );
070    }
071
072    @Inject
073    AccountingControl accountingControl;
074
075    
076    /** Creates a new instance of EditGlAccountClassCommand */
077    public EditGlAccountClassCommand() {
078        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    protected BaseResult execute() {
083        var result = AccountingResultFactory.getEditGlAccountClassResult();
084        
085        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
086            var glAccountClassName = spec.getGlAccountClassName();
087            var glAccountClass = accountingControl.getGlAccountClassByName(glAccountClassName);
088            
089            if(glAccountClass != null) {
090                if(editMode.equals(EditMode.LOCK)) {
091                    if(lockEntity(glAccountClass)) {
092                        var glAccountClassDescription = accountingControl.getGlAccountClassDescription(glAccountClass, getPreferredLanguage());
093                        var edit = AccountingEditFactory.getGlAccountClassEdit();
094                        var glAccountClassDetail = glAccountClass.getLastDetail();
095                        var parentGlAccountClass = glAccountClassDetail.getParentGlAccountClass();
096
097                        result.setGlAccountClass(accountingControl.getGlAccountClassTransfer(getUserVisit(), glAccountClass));
098
099                        result.setEdit(edit);
100                        edit.setGlAccountClassName(glAccountClassDetail.getGlAccountClassName());
101                        edit.setParentGlAccountClassName(parentGlAccountClass == null? null: parentGlAccountClass.getLastDetail().getGlAccountClassName());
102                        edit.setIsDefault(glAccountClassDetail.getIsDefault().toString());
103                        edit.setSortOrder(glAccountClassDetail.getSortOrder().toString());
104
105                        if(glAccountClassDescription != null) {
106                            edit.setDescription(glAccountClassDescription.getDescription());
107                        }
108                    } else {
109                        addExecutionError(ExecutionErrors.EntityLockFailed.name());
110                    }
111
112                    result.setEntityLock(getEntityLockTransfer(glAccountClass));
113                } else { // EditMode.ABANDON
114                    unlockEntity(glAccountClass);
115                }
116            } else {
117                addExecutionError(ExecutionErrors.UnknownGlAccountClassName.name(), glAccountClassName);
118            }
119        } else if(editMode.equals(EditMode.UPDATE)) {
120            var glAccountClassName = spec.getGlAccountClassName();
121            var glAccountClass = accountingControl.getGlAccountClassByNameForUpdate(glAccountClassName);
122            
123            if(glAccountClass != null) {
124                glAccountClassName = edit.getGlAccountClassName();
125                var duplicateGlAccountClass = accountingControl.getGlAccountClassByName(glAccountClassName);
126                
127                if(duplicateGlAccountClass == null || glAccountClass.equals(duplicateGlAccountClass)) {
128                    var parentGlAccountClassName = edit.getParentGlAccountClassName();
129                    GlAccountClass parentGlAccountClass = null;
130                    
131                    if(parentGlAccountClassName != null) {
132                        parentGlAccountClass = accountingControl.getGlAccountClassByName(parentGlAccountClassName);
133                    }
134                    
135                    if(parentGlAccountClassName == null || parentGlAccountClass != null) {
136                        if(accountingControl.isParentGlAccountClassSafe(glAccountClass, parentGlAccountClass)) {
137                            if(lockEntityForUpdate(glAccountClass)) {
138                                try {
139                                    var partyPK = getPartyPK();
140                                    var glAccountClassDetailValue = accountingControl.getGlAccountClassDetailValueForUpdate(glAccountClass);
141                                    var glAccountClassDescription = accountingControl.getGlAccountClassDescriptionForUpdate(glAccountClass, getPreferredLanguage());
142                                    var description = edit.getDescription();
143                                    
144                                    glAccountClassDetailValue.setGlAccountClassName(edit.getGlAccountClassName());
145                                    glAccountClassDetailValue.setParentGlAccountClassPK(parentGlAccountClass == null? null: parentGlAccountClass.getPrimaryKey());
146                                    glAccountClassDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
147                                    glAccountClassDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
148                                    
149                                    accountingControl.updateGlAccountClassFromValue(glAccountClassDetailValue, partyPK);
150                                    
151                                    if(glAccountClassDescription == null && description != null) {
152                                        accountingControl.createGlAccountClassDescription(glAccountClass, getPreferredLanguage(), description, partyPK);
153                                    } else if(glAccountClassDescription != null && description == null) {
154                                        accountingControl.deleteGlAccountClassDescription(glAccountClassDescription, partyPK);
155                                    } else if(glAccountClassDescription != null && description != null) {
156                                        var glAccountClassDescriptionValue = accountingControl.getGlAccountClassDescriptionValue(glAccountClassDescription);
157                                        
158                                        glAccountClassDescriptionValue.setDescription(description);
159                                        accountingControl.updateGlAccountClassDescriptionFromValue(glAccountClassDescriptionValue, partyPK);
160                                    }
161                                } finally {
162                                    unlockEntity(glAccountClass);
163                                }
164                            } else {
165                                addExecutionError(ExecutionErrors.EntityLockStale.name());
166                            }
167                        } else {
168                            addExecutionError(ExecutionErrors.InvalidParentGlAccountClass.name());
169                        }
170                    } else {
171                        addExecutionError(ExecutionErrors.UnknownParentGlAccountClassName.name(), parentGlAccountClassName);
172                    }
173                } else {
174                    addExecutionError(ExecutionErrors.DuplicateGlAccountClassName.name(), glAccountClassName);
175                }
176            } else {
177                addExecutionError(ExecutionErrors.UnknownGlAccountClassName.name(), glAccountClassName);
178            }
179            
180            if(hasExecutionErrors()) {
181                result.setGlAccountClass(accountingControl.getGlAccountClassTransfer(getUserVisit(), glAccountClass));
182                result.setEntityLock(getEntityLockTransfer(glAccountClass));
183            }
184        }
185        
186        return result;
187    }
188    
189}