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.SymbolPositionEdit;
021import com.echothree.control.user.accounting.common.form.EditSymbolPositionForm;
022import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
023import com.echothree.control.user.accounting.common.spec.SymbolPositionSpec;
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.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.common.command.EditMode;
034import com.echothree.util.server.control.BaseEditCommand;
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.List;
040import javax.enterprise.context.Dependent;
041
042@Dependent
043public class EditSymbolPositionCommand
044        extends BaseEditCommand<SymbolPositionSpec, SymbolPositionEdit> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
048    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
054                    new SecurityRoleDefinition(SecurityRoleGroups.SymbolPosition.name(), SecurityRoles.Edit.name())
055                    ))
056                ));
057        
058        SPEC_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("SymbolPositionName", FieldType.ENTITY_NAME, true, null, null)
060                );
061        
062        EDIT_FIELD_DEFINITIONS = List.of(
063                new FieldDefinition("SymbolPositionName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
065                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
066                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
067                );
068    }
069    
070    /** Creates a new instance of EditSymbolPositionCommand */
071    public EditSymbolPositionCommand() {
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.getEditSymbolPositionResult();
079        
080        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
081            var symbolPositionName = spec.getSymbolPositionName();
082            var symbolPosition = accountingControl.getSymbolPositionByName(symbolPositionName);
083            
084            if(symbolPosition != null) {
085                if(editMode.equals(EditMode.LOCK)) {
086                    if(lockEntity(symbolPosition)) {
087                        var symbolPositionDescription = accountingControl.getSymbolPositionDescription(symbolPosition, getPreferredLanguage());
088                        var edit = AccountingEditFactory.getSymbolPositionEdit();
089                        var symbolPositionDetail = symbolPosition.getLastDetail();
090
091                        result.setSymbolPosition(accountingControl.getSymbolPositionTransfer(getUserVisit(), symbolPosition));
092
093                        result.setEdit(edit);
094                        edit.setSymbolPositionName(symbolPositionDetail.getSymbolPositionName());
095                        edit.setIsDefault(symbolPositionDetail.getIsDefault().toString());
096                        edit.setSortOrder(symbolPositionDetail.getSortOrder().toString());
097
098                        if(symbolPositionDescription != null) {
099                            edit.setDescription(symbolPositionDescription.getDescription());
100                        }
101                    } else {
102                        addExecutionError(ExecutionErrors.EntityLockFailed.name());
103                    }
104
105                    result.setEntityLock(getEntityLockTransfer(symbolPosition));
106                } else { // EditMode.ABANDON
107                    unlockEntity(symbolPosition);
108                }
109            } else {
110                addExecutionError(ExecutionErrors.UnknownSymbolPositionName.name(), symbolPositionName);
111            }
112        } else if(editMode.equals(EditMode.UPDATE)) {
113            var symbolPositionName = spec.getSymbolPositionName();
114            var symbolPosition = accountingControl.getSymbolPositionByNameForUpdate(symbolPositionName);
115            
116            if(symbolPosition != null) {
117                symbolPositionName = edit.getSymbolPositionName();
118                var duplicateSymbolPosition = accountingControl.getSymbolPositionByName(symbolPositionName);
119                
120                if(duplicateSymbolPosition == null || symbolPosition.equals(duplicateSymbolPosition)) {
121                    if(lockEntityForUpdate(symbolPosition)) {
122                        try {
123                            var partyPK = getPartyPK();
124                            var symbolPositionDetailValue = accountingControl.getSymbolPositionDetailValueForUpdate(symbolPosition);
125                            var symbolPositionDescription = accountingControl.getSymbolPositionDescriptionForUpdate(symbolPosition, getPreferredLanguage());
126                            var description = edit.getDescription();
127                            
128                            symbolPositionDetailValue.setSymbolPositionName(edit.getSymbolPositionName());
129                            symbolPositionDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
130                            symbolPositionDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
131                            
132                            accountingControl.updateSymbolPositionFromValue(symbolPositionDetailValue, partyPK);
133                            
134                            if(symbolPositionDescription == null && description != null) {
135                                accountingControl.createSymbolPositionDescription(symbolPosition, getPreferredLanguage(), description, partyPK);
136                            } else if(symbolPositionDescription != null && description == null) {
137                                accountingControl.deleteSymbolPositionDescription(symbolPositionDescription, partyPK);
138                            } else if(symbolPositionDescription != null && description != null) {
139                                var symbolPositionDescriptionValue = accountingControl.getSymbolPositionDescriptionValue(symbolPositionDescription);
140                                
141                                symbolPositionDescriptionValue.setDescription(description);
142                                accountingControl.updateSymbolPositionDescriptionFromValue(symbolPositionDescriptionValue, partyPK);
143                            }
144                        } finally {
145                            unlockEntity(symbolPosition);
146                        }
147                    } else {
148                        addExecutionError(ExecutionErrors.EntityLockStale.name());
149                    }
150                } else {
151                    addExecutionError(ExecutionErrors.DuplicateSymbolPositionName.name(), symbolPositionName);
152                }
153            } else {
154                addExecutionError(ExecutionErrors.UnknownSymbolPositionName.name(), symbolPositionName);
155            }
156            
157            if(hasExecutionErrors()) {
158                result.setSymbolPosition(accountingControl.getSymbolPositionTransfer(getUserVisit(), symbolPosition));
159                result.setEntityLock(getEntityLockTransfer(symbolPosition));
160            }
161        }
162        
163        return result;
164    }
165    
166}