001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.result.EditSymbolPositionResult;
024import com.echothree.control.user.accounting.common.spec.SymbolPositionSpec;
025import com.echothree.model.control.accounting.server.control.AccountingControl;
026import com.echothree.model.control.core.common.EventTypes;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.accounting.server.entity.SymbolPosition;
031import com.echothree.model.data.accounting.server.entity.SymbolPositionDescription;
032import com.echothree.model.data.accounting.server.entity.SymbolPositionDetail;
033import com.echothree.model.data.accounting.server.value.SymbolPositionDescriptionValue;
034import com.echothree.model.data.accounting.server.value.SymbolPositionDetailValue;
035import com.echothree.model.data.user.common.pk.UserVisitPK;
036import com.echothree.util.common.message.ExecutionErrors;
037import com.echothree.util.common.validation.FieldDefinition;
038import com.echothree.util.common.validation.FieldType;
039import com.echothree.util.common.command.BaseResult;
040import com.echothree.util.common.command.EditMode;
041import com.echothree.util.server.control.BaseEditCommand;
042import com.echothree.util.server.control.CommandSecurityDefinition;
043import com.echothree.util.server.control.PartyTypeDefinition;
044import com.echothree.util.server.control.SecurityRoleDefinition;
045import com.echothree.util.server.persistence.Session;
046import java.util.Arrays;
047import java.util.Collections;
048import java.util.List;
049
050public class EditSymbolPositionCommand
051        extends BaseEditCommand<SymbolPositionSpec, SymbolPositionEdit> {
052    
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056    
057    static {
058        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
061                    new SecurityRoleDefinition(SecurityRoleGroups.SymbolPosition.name(), SecurityRoles.Edit.name())
062                    )))
063                )));
064        
065        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("SymbolPositionName", FieldType.ENTITY_NAME, true, null, null)
067                ));
068        
069        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
070                new FieldDefinition("SymbolPositionName", FieldType.ENTITY_NAME, true, null, null),
071                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
072                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
073                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
074                ));
075    }
076    
077    /** Creates a new instance of EditSymbolPositionCommand */
078    public EditSymbolPositionCommand(UserVisitPK userVisitPK, EditSymbolPositionForm form) {
079        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
080    }
081    
082    @Override
083    protected BaseResult execute() {
084        var accountingControl = Session.getModelController(AccountingControl.class);
085        EditSymbolPositionResult result = AccountingResultFactory.getEditSymbolPositionResult();
086        
087        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
088            String symbolPositionName = spec.getSymbolPositionName();
089            SymbolPosition symbolPosition = accountingControl.getSymbolPositionByName(symbolPositionName);
090            
091            if(symbolPosition != null) {
092                if(editMode.equals(EditMode.LOCK)) {
093                    if(lockEntity(symbolPosition)) {
094                        SymbolPositionDescription symbolPositionDescription = accountingControl.getSymbolPositionDescription(symbolPosition, getPreferredLanguage());
095                        SymbolPositionEdit edit = AccountingEditFactory.getSymbolPositionEdit();
096                        SymbolPositionDetail symbolPositionDetail = symbolPosition.getLastDetail();
097
098                        result.setSymbolPosition(accountingControl.getSymbolPositionTransfer(getUserVisit(), symbolPosition));
099
100                        result.setEdit(edit);
101                        edit.setSymbolPositionName(symbolPositionDetail.getSymbolPositionName());
102                        edit.setIsDefault(symbolPositionDetail.getIsDefault().toString());
103                        edit.setSortOrder(symbolPositionDetail.getSortOrder().toString());
104
105                        if(symbolPositionDescription != null) {
106                            edit.setDescription(symbolPositionDescription.getDescription());
107                        }
108                    } else {
109                        addExecutionError(ExecutionErrors.EntityLockFailed.name());
110                    }
111
112                    result.setEntityLock(getEntityLockTransfer(symbolPosition));
113                } else { // EditMode.ABANDON
114                    unlockEntity(symbolPosition);
115                }
116            } else {
117                addExecutionError(ExecutionErrors.UnknownSymbolPositionName.name(), symbolPositionName);
118            }
119        } else if(editMode.equals(EditMode.UPDATE)) {
120            String symbolPositionName = spec.getSymbolPositionName();
121            SymbolPosition symbolPosition = accountingControl.getSymbolPositionByNameForUpdate(symbolPositionName);
122            
123            if(symbolPosition != null) {
124                symbolPositionName = edit.getSymbolPositionName();
125                SymbolPosition duplicateSymbolPosition = accountingControl.getSymbolPositionByName(symbolPositionName);
126                
127                if(duplicateSymbolPosition == null || symbolPosition.equals(duplicateSymbolPosition)) {
128                    if(lockEntityForUpdate(symbolPosition)) {
129                        try {
130                            var partyPK = getPartyPK();
131                            SymbolPositionDetailValue symbolPositionDetailValue = accountingControl.getSymbolPositionDetailValueForUpdate(symbolPosition);
132                            SymbolPositionDescription symbolPositionDescription = accountingControl.getSymbolPositionDescriptionForUpdate(symbolPosition, getPreferredLanguage());
133                            String description = edit.getDescription();
134                            
135                            symbolPositionDetailValue.setSymbolPositionName(edit.getSymbolPositionName());
136                            symbolPositionDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
137                            symbolPositionDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
138                            
139                            accountingControl.updateSymbolPositionFromValue(symbolPositionDetailValue, partyPK);
140                            
141                            if(symbolPositionDescription == null && description != null) {
142                                accountingControl.createSymbolPositionDescription(symbolPosition, getPreferredLanguage(), description, partyPK);
143                            } else if(symbolPositionDescription != null && description == null) {
144                                accountingControl.deleteSymbolPositionDescription(symbolPositionDescription, partyPK);
145                            } else if(symbolPositionDescription != null && description != null) {
146                                SymbolPositionDescriptionValue symbolPositionDescriptionValue = accountingControl.getSymbolPositionDescriptionValue(symbolPositionDescription);
147                                
148                                symbolPositionDescriptionValue.setDescription(description);
149                                accountingControl.updateSymbolPositionDescriptionFromValue(symbolPositionDescriptionValue, partyPK);
150                            }
151                        } finally {
152                            unlockEntity(symbolPosition);
153                        }
154                    } else {
155                        addExecutionError(ExecutionErrors.EntityLockStale.name());
156                    }
157                } else {
158                    addExecutionError(ExecutionErrors.DuplicateSymbolPositionName.name(), symbolPositionName);
159                }
160            } else {
161                addExecutionError(ExecutionErrors.UnknownSymbolPositionName.name(), symbolPositionName);
162            }
163            
164            if(hasExecutionErrors()) {
165                result.setSymbolPosition(accountingControl.getSymbolPositionTransfer(getUserVisit(), symbolPosition));
166                result.setEntityLock(getEntityLockTransfer(symbolPosition));
167            }
168        }
169        
170        return result;
171    }
172    
173}