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
019
020import com.echothree.control.user.employee.common.form.GetTerminationReasonChoicesForm;
021import com.echothree.control.user.employee.common.result.EmployeeResultFactory;
022import com.echothree.control.user.employee.common.result.GetTerminationReasonChoicesResult;
023import com.echothree.model.control.employee.server.control.EmployeeControl;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class GetTerminationReasonChoicesCommand
041        extends BaseSimpleCommand<GetTerminationReasonChoicesForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.TerminationReason.name(), SecurityRoles.Choices.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055            new FieldDefinition("DefaultTerminationReasonChoice", FieldType.ENTITY_NAME, false, null, null),
056            new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
057        ));
058    }
059    
060    /** Creates a new instance of GetTerminationReasonChoicesCommand */
061    public GetTerminationReasonChoicesCommand(UserVisitPK userVisitPK, GetTerminationReasonChoicesForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var employeeControl = Session.getModelController(EmployeeControl.class);
068        GetTerminationReasonChoicesResult result = EmployeeResultFactory.getGetTerminationReasonChoicesResult();
069        String defaultTerminationReasonChoice = form.getDefaultTerminationReasonChoice();
070        boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
071        
072        result.setTerminationReasonChoices(employeeControl.getTerminationReasonChoices(defaultTerminationReasonChoice,
073                getPreferredLanguage(), allowNullChoice));
074        
075        return result;
076    }
077    
078}