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.GetTrainingClassSectionForm;
020import com.echothree.control.user.training.common.result.GetTrainingClassSectionResult;
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.PartyTrainingClassSessionSection;
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.TrainingClassSection;
033import com.echothree.model.data.user.common.pk.UserVisitPK;
034import com.echothree.model.data.user.server.entity.UserVisit;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.BaseResult;
039import com.echothree.util.server.control.BaseSimpleCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import com.echothree.util.server.persistence.Session;
044import java.util.Arrays;
045import java.util.Collections;
046import java.util.List;
047
048public class GetTrainingClassSectionCommand
049        extends BaseSimpleCommand<GetTrainingClassSectionForm> {
050    
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
053    
054    static {
055        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
056                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
057                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
058                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassSection.name(), SecurityRoles.Review.name())
059                        )))
060                )));
061
062        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
063                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, false, null, null)
066                ));
067    }
068    
069    /** Creates a new instance of GetTrainingClassSectionCommand */
070    public GetTrainingClassSectionCommand(UserVisitPK userVisitPK, GetTrainingClassSectionForm form) {
071        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var trainingControl = Session.getModelController(TrainingControl.class);
077        GetTrainingClassSectionResult result = TrainingResultFactory.getGetTrainingClassSectionResult();
078        String trainingClassName = form.getTrainingClassName();
079        TrainingClass trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
080
081        if(trainingClass != null) {
082            String trainingClassSectionName = form.getTrainingClassSectionName();
083            TrainingClassSection trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
084
085            if(trainingClassSection != null) {
086                String partyTrainingClassName = form.getPartyTrainingClassName();
087                PartyTrainingClassSessionStatus partyTrainingClassSessionStatus = partyTrainingClassName == null ? null
088                        : PartyTrainingClassSessionLogic.getInstance().getLatestPartyTrainingClassSessionStatusForUpdate(this, partyTrainingClassName);
089
090                if(!hasExecutionErrors()) {
091                    PartyTrainingClassSession 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                        UserVisit userVisit = getUserVisit();
103                        var partyPK = getPartyPK();
104
105                        result.setTrainingClassSection(trainingControl.getTrainingClassSectionTransfer(userVisit, trainingClassSection));
106
107                        sendEvent(trainingClassSection.getPrimaryKey(), EventTypes.READ, null, null, partyPK);
108
109                        if(partyTrainingClassSessionStatus != null) {
110                            PartyTrainingClassSessionSection partyTrainingClassSessionSection = trainingControl.createPartyTrainingClassSessionSection(partyTrainingClassSession,
111                                    trainingClassSection, session.START_TIME_LONG, null, partyPK);
112
113                            PartyTrainingClassSessionLogic.getInstance().updatePartyTrainingClassSessionStatus(session, partyTrainingClassSessionStatus,
114                                    partyTrainingClassSessionSection, null, null);
115                            
116                            result.setPartyTrainingClassSessionSection(trainingControl.getPartyTrainingClassSessionSectionTransfer(userVisit, partyTrainingClassSessionSection));
117                        }
118                    }
119                }
120            } else {
121                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
122            }
123        } else {
124            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
125        }
126
127        return result;
128    }
129    
130}