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.training.server.command;
018
019import com.echothree.control.user.training.common.form.GetPartyTrainingClassStatusChoicesForm;
020import com.echothree.control.user.training.common.result.TrainingResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.training.server.control.TrainingControl;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class GetPartyTrainingClassStatusChoicesCommand
040        extends BaseSimpleCommand<GetPartyTrainingClassStatusChoicesForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                    new SecurityRoleDefinition(SecurityRoleGroups.PartyTrainingClassStatus.name(), SecurityRoles.Choices.name())
049                    ))
050                ));
051        
052        FORM_FIELD_DEFINITIONS = List.of(
053            new FieldDefinition("TrainingName", FieldType.ENTITY_NAME, false, null, null),
054            new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, true, null, null),
055            new FieldDefinition("DefaultPartyTrainingClassStatusChoice", FieldType.ENTITY_NAME, false, null, null),
056            new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
057        );
058    }
059    
060    /** Creates a new instance of GetPartyTrainingClassStatusChoicesCommand */
061    public GetPartyTrainingClassStatusChoicesCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var trainingControl = Session.getModelController(TrainingControl.class);
068        var result = TrainingResultFactory.getGetPartyTrainingClassStatusChoicesResult();
069        var partyTrainingClassName = form.getPartyTrainingClassName();
070        var partyTrainingClass = trainingControl.getPartyTrainingClassByName(partyTrainingClassName);
071
072            if(partyTrainingClass != null) {
073                var defaultPartyTrainingClassStatusChoice = form.getDefaultPartyTrainingClassStatusChoice();
074                var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
075
076                result.setPartyTrainingClassStatusChoices(trainingControl.getPartyTrainingClassStatusChoices(defaultPartyTrainingClassStatusChoice,
077                        getPreferredLanguage(), allowNullChoice, partyTrainingClass, getPartyPK()));
078            } else {
079                addExecutionError(ExecutionErrors.UnknownPartyTrainingClassName.name(), partyTrainingClassName);
080            }
081        
082        return result;
083    }
084    
085}