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.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.EmployeeResultFactory;
023import com.echothree.control.user.employee.common.spec.TerminationReasonDescriptionSpec;
024import com.echothree.model.control.employee.server.control.EmployeeControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.ArrayList;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class EditTerminationReasonDescriptionCommand
046        extends BaseEditCommand<TerminationReasonDescriptionSpec, TerminationReasonDescriptionEdit> {
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(List.of(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
056                        new SecurityRoleDefinition(SecurityRoleGroups.TerminationReason.name(), SecurityRoles.Description.name())
057                ))
058        ));
059
060        SPEC_FIELD_DEFINITIONS = List.of(
061                new FieldDefinition("TerminationReasonName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
063        );
064        
065        EDIT_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
067        );
068    }
069
070    @Inject
071    EmployeeControl employeeControl;
072
073    @Inject
074    PartyControl partyControl;
075
076    
077    /** Creates a new instance of EditTerminationReasonDescriptionCommand */
078    public EditTerminationReasonDescriptionCommand() {
079        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
080    }
081    
082    @Override
083    protected BaseResult execute() {
084        var result = EmployeeResultFactory.getEditTerminationReasonDescriptionResult();
085        var terminationReasonName = spec.getTerminationReasonName();
086        var terminationReason = employeeControl.getTerminationReasonByName(terminationReasonName);
087        
088        if(terminationReason != null) {
089            var languageIsoName = spec.getLanguageIsoName();
090            var language = partyControl.getLanguageByIsoName(languageIsoName);
091            
092            if(language != null) {
093                if(editMode.equals(EditMode.LOCK)) {
094                    var terminationReasonDescription = employeeControl.getTerminationReasonDescription(terminationReason, language);
095                    
096                    if(terminationReasonDescription != null) {
097                        result.setTerminationReasonDescription(employeeControl.getTerminationReasonDescriptionTransfer(getUserVisit(), terminationReasonDescription));
098                        
099                        if(lockEntity(terminationReason)) {
100                            var edit = EmployeeEditFactory.getTerminationReasonDescriptionEdit();
101                            
102                            result.setEdit(edit);
103                            edit.setDescription(terminationReasonDescription.getDescription());
104                        } else {
105                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
106                        }
107                        
108                        result.setEntityLock(getEntityLockTransfer(terminationReason));
109                    } else {
110                        addExecutionError(ExecutionErrors.UnknownTerminationReasonDescription.name());
111                    }
112                } else if(editMode.equals(EditMode.UPDATE)) {
113                    var terminationReasonDescriptionValue = employeeControl.getTerminationReasonDescriptionValueForUpdate(terminationReason, language);
114                    
115                    if(terminationReasonDescriptionValue != null) {
116                        if(lockEntityForUpdate(terminationReason)) {
117                            try {
118                                var description = edit.getDescription();
119                                
120                                terminationReasonDescriptionValue.setDescription(description);
121                                
122                                employeeControl.updateTerminationReasonDescriptionFromValue(terminationReasonDescriptionValue, getPartyPK());
123                            } finally {
124                                unlockEntity(terminationReason);
125                            }
126                        } else {
127                            addExecutionError(ExecutionErrors.EntityLockStale.name());
128                        }
129                    } else {
130                        addExecutionError(ExecutionErrors.UnknownTerminationReasonDescription.name());
131                    }
132                }
133            } else {
134                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
135            }
136        } else {
137            addExecutionError(ExecutionErrors.UnknownTerminationReasonName.name(), terminationReasonName);
138        }
139        
140        return result;
141    }
142    
143}