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.SymbolPositionDescriptionEdit;
021import com.echothree.control.user.accounting.common.form.EditSymbolPositionDescriptionForm;
022import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
023import com.echothree.control.user.accounting.common.result.EditSymbolPositionDescriptionResult;
024import com.echothree.control.user.accounting.common.spec.SymbolPositionDescriptionSpec;
025import com.echothree.model.control.accounting.server.control.AccountingControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
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.value.SymbolPositionDescriptionValue;
033import com.echothree.model.data.party.server.entity.Language;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.BaseResult;
039import com.echothree.util.common.command.EditMode;
040import com.echothree.util.server.control.BaseEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import com.echothree.util.server.persistence.Session;
045import java.util.Arrays;
046import java.util.Collections;
047import java.util.List;
048
049public class EditSymbolPositionDescriptionCommand
050        extends BaseEditCommand<SymbolPositionDescriptionSpec, SymbolPositionDescriptionEdit> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
060                        new SecurityRoleDefinition(SecurityRoleGroups.SymbolPosition.name(), SecurityRoles.Description.name())
061                        )))
062                )));
063        
064        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
065                new FieldDefinition("SymbolPositionName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
067                ));
068        
069        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
070                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
071                ));
072    }
073    
074    /** Creates a new instance of EditSymbolPositionDescriptionCommand */
075    public EditSymbolPositionDescriptionCommand(UserVisitPK userVisitPK, EditSymbolPositionDescriptionForm form) {
076        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078    
079    @Override
080    protected BaseResult execute() {
081        var accountingControl = Session.getModelController(AccountingControl.class);
082        EditSymbolPositionDescriptionResult result = AccountingResultFactory.getEditSymbolPositionDescriptionResult();
083        String symbolPositionName = spec.getSymbolPositionName();
084        SymbolPosition symbolPosition = accountingControl.getSymbolPositionByName(symbolPositionName);
085        
086        if(symbolPosition != null) {
087            var partyControl = Session.getModelController(PartyControl.class);
088            String languageIsoName = spec.getLanguageIsoName();
089            Language language = partyControl.getLanguageByIsoName(languageIsoName);
090            
091            if(language != null) {
092                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093                    SymbolPositionDescription symbolPositionDescription = accountingControl.getSymbolPositionDescription(symbolPosition, language);
094                    
095                    if(symbolPositionDescription != null) {
096                        if(editMode.equals(EditMode.LOCK)) {
097                            result.setSymbolPositionDescription(accountingControl.getSymbolPositionDescriptionTransfer(getUserVisit(), symbolPositionDescription));
098
099                            if(lockEntity(symbolPosition)) {
100                                SymbolPositionDescriptionEdit edit = AccountingEditFactory.getSymbolPositionDescriptionEdit();
101
102                                result.setEdit(edit);
103                                edit.setDescription(symbolPositionDescription.getDescription());
104                            } else {
105                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
106                            }
107
108                            result.setEntityLock(getEntityLockTransfer(symbolPosition));
109                        } else { // EditMode.ABANDON
110                            unlockEntity(symbolPosition);
111                        }
112                    } else {
113                        addExecutionError(ExecutionErrors.UnknownSymbolPositionDescription.name());
114                    }
115                } else if(editMode.equals(EditMode.UPDATE)) {
116                    SymbolPositionDescriptionValue symbolPositionDescriptionValue = accountingControl.getSymbolPositionDescriptionValueForUpdate(symbolPosition, language);
117                    
118                    if(symbolPositionDescriptionValue != null) {
119                        if(lockEntityForUpdate(symbolPosition)) {
120                            try {
121                                String description = edit.getDescription();
122                                
123                                symbolPositionDescriptionValue.setDescription(description);
124                                
125                                accountingControl.updateSymbolPositionDescriptionFromValue(symbolPositionDescriptionValue, getPartyPK());
126                            } finally {
127                                unlockEntity(symbolPosition);
128                            }
129                        } else {
130                            addExecutionError(ExecutionErrors.EntityLockStale.name());
131                        }
132                    } else {
133                        addExecutionError(ExecutionErrors.UnknownSymbolPositionDescription.name());
134                    }
135                }
136            } else {
137                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
138            }
139        } else {
140            addExecutionError(ExecutionErrors.UnknownSymbolPositionName.name(), symbolPositionName);
141        }
142        
143        return result;
144    }
145    
146}