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