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.GetTrainingClassPageForm;
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.util.common.command.BaseResult;
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.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 java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetTrainingClassPageCommand
041        extends BaseSimpleCommand<GetTrainingClassPageForm> {
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(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassPage.name(), SecurityRoles.Review.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("TrainingClassPageName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, false, null, null)
059        );
060    }
061
062    @Inject
063    TrainingControl trainingControl;
064
065    @Inject
066    PartyTrainingClassSessionLogic partyTrainingClassSessionLogic;
067
068    /** Creates a new instance of GetTrainingClassPageCommand */
069    public GetTrainingClassPageCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
071    }
072
073    @Override
074    protected BaseResult execute() {
075        var result = TrainingResultFactory.getGetTrainingClassPageResult();
076        var trainingClassName = form.getTrainingClassName();
077        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
078
079        if(trainingClass != null) {
080            var trainingClassSectionName = form.getTrainingClassSectionName();
081            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
082
083            if(trainingClassSection != null) {
084                var trainingClassPageName = form.getTrainingClassPageName();
085                var trainingClassPage = trainingControl.getTrainingClassPageByName(trainingClassSection, trainingClassPageName);
086
087                if(trainingClassPage != null) {
088                    var partyTrainingClassName = form.getPartyTrainingClassName();
089                    var partyTrainingClassSessionStatus = partyTrainingClassName == null ? null
090                            : partyTrainingClassSessionLogic.getLatestPartyTrainingClassSessionStatusForUpdate(this, partyTrainingClassName);
091
092                    if(!hasExecutionErrors()) {
093                        var partyTrainingClassSession = partyTrainingClassSessionStatus == null ? null
094                                : partyTrainingClassSessionStatus.getPartyTrainingClassSession();
095
096                        // Verify that the TrainingClass from above is same as the one being used by the PartyTrainingClassSession.
097                        if(partyTrainingClassSession != null) {
098                            if(!trainingClass.equals(partyTrainingClassSession.getLastDetail().getPartyTrainingClass().getLastDetail().getTrainingClass())) {
099                                addExecutionError(ExecutionErrors.InvalidPartyTrainingClass.name(), partyTrainingClassName);
100                            }
101                        }
102
103                        if(!hasExecutionErrors()) {
104                            var userVisit = getUserVisit();
105                            var partyPK = getPartyPK();
106
107                            result.setTrainingClassPage(trainingControl.getTrainingClassPageTransfer(userVisit, trainingClassPage));
108
109                            sendEvent(trainingClassPage.getPrimaryKey(), EventTypes.READ, null, null, partyPK);
110
111                            if(partyTrainingClassSessionStatus != null) {
112                                var partyTrainingClassSessionPage = trainingControl.createPartyTrainingClassSessionPage(partyTrainingClassSession,
113                                        trainingClassPage, session.getStartTime(), null, partyPK);
114
115                                partyTrainingClassSessionLogic.updatePartyTrainingClassSessionStatus(session, partyTrainingClassSessionStatus,
116                                        null, partyTrainingClassSessionPage, null);
117
118                                result.setPartyTrainingClassSessionPage(trainingControl.getPartyTrainingClassSessionPageTransfer(userVisit, partyTrainingClassSessionPage));
119                            }
120                        }
121                    }
122                } else {
123                    addExecutionError(ExecutionErrors.UnknownTrainingClassPageName.name(), trainingClassName, trainingClassSectionName, trainingClassPageName);
124                }
125            } else {
126                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
127            }
128        } else {
129            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
130        }
131
132        return result;
133    }
134    
135}