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.GetTrainingClassSectionsForm;
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.PartyTrainingClassLogic;
026import com.echothree.model.control.training.server.logic.TrainingClassLogic;
027import com.echothree.model.data.training.server.entity.TrainingClass;
028import com.echothree.model.data.training.server.entity.TrainingClassSection;
029import com.echothree.model.data.training.server.factory.TrainingClassSectionFactory;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.message.ExecutionErrors;
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 GetTrainingClassSectionsCommand
045        extends BasePaginatedMultipleEntitiesCommand<TrainingClassSection, GetTrainingClassSectionsForm> {
046    
047    private final static CommandSecurityDefinition EMPLOYEE_COMMAND_SECURITY_DEFINITION;
048    private final static CommandSecurityDefinition TESTING_COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        EMPLOYEE_COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassSection.name(), SecurityRoles.List.name())
056                ))
057        ));
058
059        TESTING_COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
060                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
061                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
062        ));
063
064        FORM_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, false, null, null),
066                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, false, null, null)
067        );
068    }
069
070    @Inject
071    TrainingControl trainingControl;
072
073    @Inject
074    PartyTrainingClassLogic partyTrainingClassLogic;
075
076    @Inject
077    TrainingClassLogic trainingClassLogic;
078
079
080    /** Creates a new instance of GetTrainingClassSectionsCommand */
081    public GetTrainingClassSectionsCommand() {
082        super(null, FORM_FIELD_DEFINITIONS, true);
083    }
084    
085    TrainingClass trainingClass;
086
087    @Override
088    protected CommandSecurityDefinition getCommandSecurityDefinition() {
089        return form.getTrainingClassName() == null ? EMPLOYEE_COMMAND_SECURITY_DEFINITION : TESTING_COMMAND_SECURITY_DEFINITION;
090    }
091
092    @Override
093    protected void handleForm() {
094        var trainingClassName = form.getTrainingClassName();
095        var partyTrainingClassName = form.getPartyTrainingClassName();
096        var parameterCount = (trainingClassName == null ? 0 : 1) + (partyTrainingClassName == null ? 0 : 1);
097
098        if(parameterCount == 0) {
099            trainingClass = trainingClassLogic.getTrainingClassByName(this, null, true);
100        } else if(parameterCount == 1) {
101            if(trainingClassName != null) {
102                trainingClass = trainingClassLogic.getTrainingClassByName(this, trainingClassName, false);
103            } else {
104                var partyTrainingClass = partyTrainingClassLogic.getPartyTrainingClassByName(this, partyTrainingClassName);
105
106                if(!hasExecutionErrors()) {
107                    partyTrainingClassLogic.checkPartyTrainingClassStatus(this, partyTrainingClass, getPartyPK());
108
109                    if(!hasExecutionErrors()) {
110                        trainingClass = partyTrainingClass.getLastDetail().getTrainingClass();
111                    }
112                }
113            }
114        } else {
115            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
116        }
117    }
118
119    @Override
120    protected Long getTotalEntities() {
121        return hasExecutionErrors() ? null : trainingControl.countTrainingClassSectionsByTrainingClass(trainingClass);
122    }
123
124    @Override
125    protected Collection<TrainingClassSection> getEntities() {
126        return hasExecutionErrors() ? null : trainingControl.getTrainingClassSections(trainingClass);
127    }
128
129    @Override
130    protected BaseResult getResult(Collection<TrainingClassSection> entities) {
131        var result = TrainingResultFactory.getGetTrainingClassSectionsResult();
132
133        if(entities != null) {
134            var userVisit = getUserVisit();
135
136            result.setTrainingClass(trainingControl.getTrainingClassTransfer(userVisit, trainingClass));
137
138            if(session.hasLimit(TrainingClassSectionFactory.class)) {
139                result.setTrainingClassSectionCount(trainingControl.countTrainingClassSectionsByTrainingClass(trainingClass));
140            }
141
142            result.setTrainingClassSections(trainingControl.getTrainingClassSectionTransfers(userVisit, entities));
143        }
144
145        return result;
146    }
147    
148}