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