001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.GetTrainingClassSectionForm;
020import com.echothree.control.user.training.common.result.TrainingResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.training.server.control.TrainingControl;
026import com.echothree.model.control.training.server.logic.PartyTrainingClassSessionLogic;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040import javax.enterprise.context.RequestScoped;
041
042@RequestScoped
043public class GetTrainingClassSectionCommand
044        extends BaseSimpleCommand<GetTrainingClassSectionForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassSection.name(), SecurityRoles.Review.name())
054                        )))
055                )));
056
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, false, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetTrainingClassSectionCommand */
065    public GetTrainingClassSectionCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var trainingControl = Session.getModelController(TrainingControl.class);
072        var result = TrainingResultFactory.getGetTrainingClassSectionResult();
073        var trainingClassName = form.getTrainingClassName();
074        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
075
076        if(trainingClass != null) {
077            var trainingClassSectionName = form.getTrainingClassSectionName();
078            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
079
080            if(trainingClassSection != null) {
081                var partyTrainingClassName = form.getPartyTrainingClassName();
082                var partyTrainingClassSessionStatus = partyTrainingClassName == null ? null
083                        : PartyTrainingClassSessionLogic.getInstance().getLatestPartyTrainingClassSessionStatusForUpdate(this, partyTrainingClassName);
084
085                if(!hasExecutionErrors()) {
086                    var partyTrainingClassSession = partyTrainingClassSessionStatus == null ? null
087                            : partyTrainingClassSessionStatus.getPartyTrainingClassSession();
088
089                    // Verify that the TrainingClass from above is same as the one being used by the PartyTrainingClassSession.
090                    if(partyTrainingClassSession != null) {
091                        if(!trainingClass.equals(partyTrainingClassSession.getLastDetail().getPartyTrainingClass().getLastDetail().getTrainingClass())) {
092                            addExecutionError(ExecutionErrors.InvalidPartyTrainingClass.name(), partyTrainingClassName);
093                        }
094                    }
095
096                    if(!hasExecutionErrors()) {
097                        var userVisit = getUserVisit();
098                        var partyPK = getPartyPK();
099
100                        result.setTrainingClassSection(trainingControl.getTrainingClassSectionTransfer(userVisit, trainingClassSection));
101
102                        sendEvent(trainingClassSection.getPrimaryKey(), EventTypes.READ, null, null, partyPK);
103
104                        if(partyTrainingClassSessionStatus != null) {
105                            var partyTrainingClassSessionSection = trainingControl.createPartyTrainingClassSessionSection(partyTrainingClassSession,
106                                    trainingClassSection, session.START_TIME_LONG, null, partyPK);
107
108                            PartyTrainingClassSessionLogic.getInstance().updatePartyTrainingClassSessionStatus(session, partyTrainingClassSessionStatus,
109                                    partyTrainingClassSessionSection, null, null);
110                            
111                            result.setPartyTrainingClassSessionSection(trainingControl.getPartyTrainingClassSessionSectionTransfer(userVisit, partyTrainingClassSessionSection));
112                        }
113                    }
114                }
115            } else {
116                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
117            }
118        } else {
119            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
120        }
121
122        return result;
123    }
124    
125}