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.model.control.training.server.logic.TrainingClassLogic;
028import com.echothree.model.control.training.server.logic.TrainingClassPageLogic;
029import com.echothree.model.control.training.server.logic.TrainingClassSectionLogic;
030import com.echothree.model.data.training.server.entity.PartyTrainingClassSessionPage;
031import com.echothree.model.data.training.server.entity.TrainingClassPage;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.server.control.BaseSingleEntityCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class GetTrainingClassPageCommand
046        extends BaseSingleEntityCommand<TrainingClassPage, GetTrainingClassPageForm> {
047
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassPage.name(), SecurityRoles.Review.name())
056                ))
057        ));
058
059        FORM_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("TrainingClassPageName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, false, null, null)
064        );
065    }
066
067    @Inject
068    TrainingControl trainingControl;
069
070    @Inject
071    PartyTrainingClassSessionLogic partyTrainingClassSessionLogic;
072
073    @Inject
074    TrainingClassLogic trainingClassLogic;
075
076    @Inject
077    TrainingClassSectionLogic trainingClassSectionLogic;
078
079    @Inject
080    TrainingClassPageLogic trainingClassPageLogic;
081
082    private PartyTrainingClassSessionPage partyTrainingClassSessionPage;
083
084    /** Creates a new instance of GetTrainingClassPageCommand */
085    public GetTrainingClassPageCommand() {
086        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
087    }
088
089    @Override
090    protected TrainingClassPage getEntity() {
091        var trainingClassName = form.getTrainingClassName();
092        var trainingClass = trainingClassLogic.getTrainingClassByName(this, trainingClassName, false);
093        TrainingClassPage trainingClassPage = null;
094
095        if(!hasExecutionErrors()) {
096            var trainingClassSectionName = form.getTrainingClassSectionName();
097            var trainingClassSection = trainingClassSectionLogic.getTrainingClassSectionByName(this, trainingClass, trainingClassSectionName);
098
099            if(!hasExecutionErrors()) {
100                var trainingClassPageName = form.getTrainingClassPageName();
101                trainingClassPage = trainingClassPageLogic.getTrainingClassPageByName(this, trainingClassSection, trainingClassPageName);
102
103                if(!hasExecutionErrors()) {
104                    var partyTrainingClassName = form.getPartyTrainingClassName();
105                    var partyTrainingClassSessionStatus = partyTrainingClassName == null ? null
106                            : partyTrainingClassSessionLogic.getLatestPartyTrainingClassSessionStatusForUpdate(this, partyTrainingClassName);
107
108                    if(!hasExecutionErrors()) {
109                        var partyTrainingClassSession = partyTrainingClassSessionStatus == null ? null
110                                : partyTrainingClassSessionStatus.getPartyTrainingClassSession();
111
112                        // Verify that the TrainingClass from above is same as the one being used by the PartyTrainingClassSession.
113                        if(partyTrainingClassSession != null) {
114                            if(!trainingClass.equals(partyTrainingClassSession.getLastDetail().getPartyTrainingClass().getLastDetail().getTrainingClass())) {
115                                addExecutionError(ExecutionErrors.InvalidPartyTrainingClass.name(), partyTrainingClassName);
116                            }
117                        }
118
119                        if(!hasExecutionErrors()) {
120                            var partyPK = getPartyPK();
121
122                            sendEvent(trainingClassPage.getPrimaryKey(), EventTypes.READ, null, null, partyPK);
123
124                            if(partyTrainingClassSessionStatus != null) {
125                                partyTrainingClassSessionPage = trainingControl.createPartyTrainingClassSessionPage(
126                                        partyTrainingClassSession, trainingClassPage, session.getStartTime(), null, partyPK);
127
128                                partyTrainingClassSessionLogic.updatePartyTrainingClassSessionStatus(session,
129                                        partyTrainingClassSessionStatus, null, partyTrainingClassSessionPage, null);
130                            }
131                        }
132                    }
133                }
134            }
135        }
136
137        return trainingClassPage;
138    }
139
140    @Override
141    protected BaseResult getResult(TrainingClassPage trainingClassPage) {
142        var result = TrainingResultFactory.getGetTrainingClassPageResult();
143
144        if(trainingClassPage != null) {
145            var userVisit = getUserVisit();
146
147            result.setTrainingClassPage(trainingControl.getTrainingClassPageTransfer(userVisit, trainingClassPage));
148
149            if(partyTrainingClassSessionPage != null) {
150                result.setPartyTrainingClassSessionPage(trainingControl.getPartyTrainingClassSessionPageTransfer(userVisit,
151                        partyTrainingClassSessionPage));
152            }
153        }
154
155        return result;
156    }
157    
158}