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.employee.server.command;
018
019import com.echothree.control.user.employee.common.edit.EmployeeEditFactory;
020import com.echothree.control.user.employee.common.edit.TerminationReasonDescriptionEdit;
021import com.echothree.control.user.employee.common.form.EditTerminationReasonDescriptionForm;
022import com.echothree.control.user.employee.common.result.EditTerminationReasonDescriptionResult;
023import com.echothree.control.user.employee.common.result.EmployeeResultFactory;
024import com.echothree.control.user.employee.common.spec.TerminationReasonDescriptionSpec;
025import com.echothree.model.control.employee.server.control.EmployeeControl;
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.employee.server.entity.TerminationReason;
031import com.echothree.model.data.employee.server.entity.TerminationReasonDescription;
032import com.echothree.model.data.employee.server.value.TerminationReasonDescriptionValue;
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.ArrayList;
046import java.util.Collections;
047import java.util.List;
048
049public class EditTerminationReasonDescriptionCommand
050        extends BaseEditCommand<TerminationReasonDescriptionSpec, TerminationReasonDescriptionEdit> {
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(List.of(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
060                        new SecurityRoleDefinition(SecurityRoleGroups.TerminationReason.name(), SecurityRoles.Description.name())
061                ))
062        ));
063
064        List<FieldDefinition> temp = new ArrayList<>(2);
065        temp.add(new FieldDefinition("TerminationReasonName", FieldType.ENTITY_NAME, true, null, null));
066        temp.add(new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null));
067        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(temp);
068        
069        temp = new ArrayList<>(1);
070        temp.add(new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L));
071        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(temp);
072    }
073    
074    /** Creates a new instance of EditTerminationReasonDescriptionCommand */
075    public EditTerminationReasonDescriptionCommand(UserVisitPK userVisitPK, EditTerminationReasonDescriptionForm form) {
076        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078    
079    @Override
080    protected BaseResult execute() {
081        var employeeControl = Session.getModelController(EmployeeControl.class);
082        EditTerminationReasonDescriptionResult result = EmployeeResultFactory.getEditTerminationReasonDescriptionResult();
083        String terminationReasonName = spec.getTerminationReasonName();
084        TerminationReason terminationReason = employeeControl.getTerminationReasonByName(terminationReasonName);
085        
086        if(terminationReason != 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)) {
093                    TerminationReasonDescription terminationReasonDescription = employeeControl.getTerminationReasonDescription(terminationReason, language);
094                    
095                    if(terminationReasonDescription != null) {
096                        result.setTerminationReasonDescription(employeeControl.getTerminationReasonDescriptionTransfer(getUserVisit(), terminationReasonDescription));
097                        
098                        if(lockEntity(terminationReason)) {
099                            TerminationReasonDescriptionEdit edit = EmployeeEditFactory.getTerminationReasonDescriptionEdit();
100                            
101                            result.setEdit(edit);
102                            edit.setDescription(terminationReasonDescription.getDescription());
103                        } else {
104                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
105                        }
106                        
107                        result.setEntityLock(getEntityLockTransfer(terminationReason));
108                    } else {
109                        addExecutionError(ExecutionErrors.UnknownTerminationReasonDescription.name());
110                    }
111                } else if(editMode.equals(EditMode.UPDATE)) {
112                    TerminationReasonDescriptionValue terminationReasonDescriptionValue = employeeControl.getTerminationReasonDescriptionValueForUpdate(terminationReason, language);
113                    
114                    if(terminationReasonDescriptionValue != null) {
115                        if(lockEntityForUpdate(terminationReason)) {
116                            try {
117                                String description = edit.getDescription();
118                                
119                                terminationReasonDescriptionValue.setDescription(description);
120                                
121                                employeeControl.updateTerminationReasonDescriptionFromValue(terminationReasonDescriptionValue, getPartyPK());
122                            } finally {
123                                unlockEntity(terminationReason);
124                            }
125                        } else {
126                            addExecutionError(ExecutionErrors.EntityLockStale.name());
127                        }
128                    } else {
129                        addExecutionError(ExecutionErrors.UnknownTerminationReasonDescription.name());
130                    }
131                }
132            } else {
133                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
134            }
135        } else {
136            addExecutionError(ExecutionErrors.UnknownTerminationReasonName.name(), terminationReasonName);
137        }
138        
139        return result;
140    }
141    
142}