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.training.server.command;
018
019
020import com.echothree.control.user.training.common.form.GetTrainingClassChoicesForm;
021import com.echothree.control.user.training.common.result.GetTrainingClassChoicesResult;
022import com.echothree.control.user.training.common.result.TrainingResultFactory;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.control.training.server.control.TrainingControl;
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 GetTrainingClassChoicesCommand
041        extends BaseSimpleCommand<GetTrainingClassChoicesForm> {
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(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
049                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClass.name(), SecurityRoles.Choices.name())
050                        )))
051                )));
052
053        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
054                new FieldDefinition("DefaultTrainingClassChoice", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
056                ));
057    }
058    
059    /** Creates a new instance of GetTrainingClassChoicesCommand */
060    public GetTrainingClassChoicesCommand(UserVisitPK userVisitPK, GetTrainingClassChoicesForm form) {
061        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
062    }
063    
064    @Override
065    protected BaseResult execute() {
066        var trainingControl = Session.getModelController(TrainingControl.class);
067        GetTrainingClassChoicesResult result = TrainingResultFactory.getGetTrainingClassChoicesResult();
068        String defaultTrainingClassChoice = form.getDefaultTrainingClassChoice();
069        boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
070        
071        result.setTrainingClassChoices(trainingControl.getTrainingClassChoices(defaultTrainingClassChoice, getPreferredLanguage(), allowNullChoice));
072        
073        return result;
074    }
075    
076}