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.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.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 GetTrainingClassPageCommand
044        extends BaseSimpleCommand<GetTrainingClassPageForm> {
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.TrainingClassPage.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("TrainingClassPageName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, false, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of GetTrainingClassPageCommand */
066    public GetTrainingClassPageCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var trainingControl = Session.getModelController(TrainingControl.class);
073        var result = TrainingResultFactory.getGetTrainingClassPageResult();
074        var trainingClassName = form.getTrainingClassName();
075        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
076
077        if(trainingClass != null) {
078            var trainingClassSectionName = form.getTrainingClassSectionName();
079            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
080
081            if(trainingClassSection != null) {
082                var trainingClassPageName = form.getTrainingClassPageName();
083                var trainingClassPage = trainingControl.getTrainingClassPageByName(trainingClassSection, trainingClassPageName);
084
085                if(trainingClassPage != null) {
086                    var partyTrainingClassName = form.getPartyTrainingClassName();
087                    var partyTrainingClassSessionStatus = partyTrainingClassName == null ? null
088                            : PartyTrainingClassSessionLogic.getInstance().getLatestPartyTrainingClassSessionStatusForUpdate(this, partyTrainingClassName);
089                    
090                    if(!hasExecutionErrors()) {
091                        var partyTrainingClassSession = partyTrainingClassSessionStatus == null ? null
092                                : partyTrainingClassSessionStatus.getPartyTrainingClassSession();
093                        
094                        // Verify that the TrainingClass from above is same as the one being used by the PartyTrainingClassSession.
095                        if(partyTrainingClassSession != null) {
096                            if(!trainingClass.equals(partyTrainingClassSession.getLastDetail().getPartyTrainingClass().getLastDetail().getTrainingClass())) {
097                                addExecutionError(ExecutionErrors.InvalidPartyTrainingClass.name(), partyTrainingClassName);
098                            }
099                        }
100                        
101                        if(!hasExecutionErrors()) {
102                            var userVisit = getUserVisit();
103                            var partyPK = getPartyPK();
104
105                            result.setTrainingClassPage(trainingControl.getTrainingClassPageTransfer(userVisit, trainingClassPage));
106
107                            sendEvent(trainingClassPage.getPrimaryKey(), EventTypes.READ, null, null, partyPK);
108
109                            if(partyTrainingClassSessionStatus != null) {
110                                var partyTrainingClassSessionPage = trainingControl.createPartyTrainingClassSessionPage(partyTrainingClassSession,
111                                        trainingClassPage, session.START_TIME_LONG, null, partyPK);
112
113                                PartyTrainingClassSessionLogic.getInstance().updatePartyTrainingClassSessionStatus(session, partyTrainingClassSessionStatus,
114                                        null, partyTrainingClassSessionPage, null);
115                                
116                                result.setPartyTrainingClassSessionPage(trainingControl.getPartyTrainingClassSessionPageTransfer(userVisit, partyTrainingClassSessionPage));
117                            }
118                        }
119                    }
120                } else {
121                    addExecutionError(ExecutionErrors.UnknownTrainingClassPageName.name(), trainingClassName, trainingClassSectionName, trainingClassPageName);
122                }
123            } else {
124                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
125            }
126        } else {
127            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
128        }
129
130        return result;
131    }
132    
133}