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.GetTrainingClassAnswersForm;
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.control.training.server.logic.TrainingClassLogic;
026import com.echothree.model.control.training.server.logic.TrainingClassQuestionLogic;
027import com.echothree.model.control.training.server.logic.TrainingClassSectionLogic;
028import com.echothree.model.data.training.server.entity.TrainingClassAnswer;
029import com.echothree.model.data.training.server.entity.TrainingClassQuestion;
030import com.echothree.model.data.training.server.factory.TrainingClassAnswerFactory;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import java.util.Collection;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class GetTrainingClassAnswersCommand
045        extends BasePaginatedMultipleEntitiesCommand<TrainingClassAnswer, GetTrainingClassAnswersForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
054                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassAnswer.name(), SecurityRoles.List.name())
055                ))
056        ));
057
058        FORM_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null)
062        );
063    }
064
065    @Inject
066    private TrainingControl trainingControl;
067
068    @Inject
069    private TrainingClassLogic trainingClassLogic;
070
071    @Inject
072    private TrainingClassQuestionLogic trainingClassQuestionLogic;
073
074    @Inject
075    private TrainingClassSectionLogic trainingClassSectionLogic;
076
077    
078    /** Creates a new instance of GetTrainingClassAnswersCommand */
079    public GetTrainingClassAnswersCommand() {
080        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
081    }
082
083    private TrainingClassQuestion trainingClassQuestion;
084
085    @Override
086    protected void handleForm() {
087        var trainingClassName = form.getTrainingClassName();
088        var trainingClass = trainingClassLogic.getTrainingClassByName(this, trainingClassName, false);
089
090        if(!hasExecutionErrors()) {
091            var trainingClassSectionName = form.getTrainingClassSectionName();
092            var trainingClassSection = trainingClassSectionLogic.getTrainingClassSectionByName(this, trainingClass, trainingClassSectionName);
093
094            if(!hasExecutionErrors()) {
095                var trainingClassQuestionName = form.getTrainingClassQuestionName();
096
097                trainingClassQuestion = trainingClassQuestionLogic.getTrainingClassQuestionByName(this, trainingClassSection, trainingClassQuestionName);
098            }
099        }
100    }
101
102    @Override
103    protected Long getTotalEntities() {
104        return hasExecutionErrors() ? null : trainingControl.countTrainingClassAnswersByTrainingClassQuestion(trainingClassQuestion);
105    }
106
107    @Override
108    protected Collection<TrainingClassAnswer> getEntities() {
109        return hasExecutionErrors() ? null : trainingControl.getTrainingClassAnswers(trainingClassQuestion);
110    }
111
112    @Override
113    protected BaseResult getResult(Collection<TrainingClassAnswer> entities) {
114        var result = TrainingResultFactory.getGetTrainingClassAnswersResult();
115
116        if(entities != null) {
117            var userVisit = getUserVisit();
118
119            result.setTrainingClassQuestion(trainingControl.getTrainingClassQuestionTransfer(userVisit, trainingClassQuestion));
120
121            if(session.hasLimit(TrainingClassAnswerFactory.class)) {
122                result.setTrainingClassAnswerCount(getTotalEntities());
123            }
124
125            result.setTrainingClassAnswers(trainingControl.getTrainingClassAnswerTransfers(userVisit, entities));
126        }
127
128        return result;
129    }
130    
131}