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.edit.PartyTrainingClassSessionAnswerEdit;
020import com.echothree.control.user.training.common.edit.TrainingEditFactory;
021import com.echothree.control.user.training.common.form.EditPartyTrainingClassSessionAnswerForm;
022import com.echothree.control.user.training.common.result.EditPartyTrainingClassSessionAnswerResult;
023import com.echothree.control.user.training.common.result.TrainingResultFactory;
024import com.echothree.control.user.training.common.spec.PartyTrainingClassSessionAnswerSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.training.server.control.TrainingControl;
029import com.echothree.model.control.training.server.logic.PartyTrainingClassLogic;
030import com.echothree.model.control.training.server.logic.PartyTrainingClassSessionLogic;
031import com.echothree.model.control.training.server.logic.TrainingClassLogic;
032import com.echothree.model.data.party.server.entity.DateTimeFormat;
033import com.echothree.model.data.training.server.entity.PartyTrainingClass;
034import com.echothree.model.data.training.server.entity.PartyTrainingClassSession;
035import com.echothree.model.data.training.server.entity.PartyTrainingClassSessionAnswer;
036import com.echothree.model.data.training.server.entity.PartyTrainingClassSessionQuestion;
037import com.echothree.model.data.training.server.entity.TrainingClassAnswer;
038import com.echothree.model.data.training.server.entity.TrainingClassQuestion;
039import com.echothree.model.data.training.server.entity.TrainingClassSection;
040import com.echothree.model.data.training.server.value.PartyTrainingClassSessionAnswerValue;
041import com.echothree.model.data.user.common.pk.UserVisitPK;
042import com.echothree.model.data.user.server.entity.UserVisit;
043import com.echothree.util.common.validation.FieldDefinition;
044import com.echothree.util.common.validation.FieldType;
045import com.echothree.util.common.command.EditMode;
046import com.echothree.util.server.control.BaseAbstractEditCommand;
047import com.echothree.util.server.control.CommandSecurityDefinition;
048import com.echothree.util.server.control.PartyTypeDefinition;
049import com.echothree.util.server.control.SecurityRoleDefinition;
050import com.echothree.util.server.persistence.Session;
051import com.echothree.util.server.string.DateUtils;
052import java.util.Arrays;
053import java.util.Collections;
054import java.util.List;
055
056public class EditPartyTrainingClassSessionAnswerCommand
057        extends BaseAbstractEditCommand<PartyTrainingClassSessionAnswerSpec, PartyTrainingClassSessionAnswerEdit, EditPartyTrainingClassSessionAnswerResult, PartyTrainingClassSessionAnswer, PartyTrainingClassSessionQuestion> {
058    
059    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
060    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
061    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
062    
063    static {
064        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
065                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
066                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
067                        new SecurityRoleDefinition(SecurityRoleGroups.PartyTrainingClassSessionAnswer.name(), SecurityRoles.Edit.name())
068                        )))
069                )));
070
071        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
072                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, true, null, null),
073                new FieldDefinition("PartyTrainingClassSessionSequence", FieldType.UNSIGNED_INTEGER, true, null, null),
074                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
075                new FieldDefinition("TrainingClassQuestionName", FieldType.ENTITY_NAME, true, null, null),
076                new FieldDefinition("PartyTrainingClassSessionAnswerSequence", FieldType.UNSIGNED_INTEGER, true, null, null)
077                ));
078
079        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
080                new FieldDefinition("TrainingClassAnswerName", FieldType.ENTITY_NAME, false, null, null),
081                new FieldDefinition("QuestionStartTime", FieldType.DATE_TIME, true, null, null),
082                new FieldDefinition("QuestionEndTime", FieldType.DATE_TIME, false, null, null)
083                ));
084    }
085    
086    /** Creates a new instance of EditPartyTrainingClassSessionAnswerCommand */
087    public EditPartyTrainingClassSessionAnswerCommand(UserVisitPK userVisitPK, EditPartyTrainingClassSessionAnswerForm form) {
088        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
089    }
090    
091    @Override
092    public EditPartyTrainingClassSessionAnswerResult getResult() {
093        return TrainingResultFactory.getEditPartyTrainingClassSessionAnswerResult();
094    }
095
096    @Override
097    public PartyTrainingClassSessionAnswerEdit getEdit() {
098        return TrainingEditFactory.getPartyTrainingClassSessionAnswerEdit();
099    }
100
101    @Override
102    public PartyTrainingClassSessionAnswer getEntity(EditPartyTrainingClassSessionAnswerResult result) {
103        PartyTrainingClassSessionAnswer partyTrainingClassSessionAnswer = null;
104        PartyTrainingClass partyTrainingClass = PartyTrainingClassLogic.getInstance().getPartyTrainingClassByName(this, spec.getPartyTrainingClassName());
105        
106        if(!hasExecutionErrors()) {
107            Integer partyTrainingClassSessionSequence = Integer.valueOf(spec.getPartyTrainingClassSessionSequence());
108            PartyTrainingClassSession partyTrainingClassSession = PartyTrainingClassSessionLogic.getInstance().getPartyTrainingClassSession(this,
109                    partyTrainingClass, partyTrainingClassSessionSequence);
110            
111            if(!hasExecutionErrors()) {
112                TrainingClassSection trainingClassSection = TrainingClassLogic.getInstance().getTrainingClassSectionByName(this,
113                        partyTrainingClassSession.getLastDetail().getPartyTrainingClass().getLastDetail().getTrainingClass(),
114                        spec.getTrainingClassSectionName());
115                
116                if(!hasExecutionErrors()) {
117                    TrainingClassQuestion trainingClassQuestion = TrainingClassLogic.getInstance().getTrainingClassQuestionByName(this, trainingClassSection,
118                            spec.getTrainingClassQuestionName());
119                    
120                    if(!hasExecutionErrors()) {
121                        PartyTrainingClassSessionQuestion partyTrainingClassSessionQuestion = PartyTrainingClassSessionLogic.getInstance().getPartyTrainingClassSessionQuestion(this,
122                                partyTrainingClassSession, trainingClassQuestion);
123                        
124                        if(!hasExecutionErrors()) {
125                            Integer partyTrainingClassSessionAnswerSequence = Integer.valueOf(spec.getPartyTrainingClassSessionAnswerSequence());
126
127                            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
128                                partyTrainingClassSessionAnswer = PartyTrainingClassSessionLogic.getInstance().getPartyTrainingClassSessionAnswer(this,
129                                        partyTrainingClassSessionQuestion, partyTrainingClassSessionAnswerSequence);
130                            } else { // EditMode.UPDATE
131                                partyTrainingClassSessionAnswer = PartyTrainingClassSessionLogic.getInstance().getPartyTrainingClassSessionAnswerForUpdate(this,
132                                        partyTrainingClassSessionQuestion, partyTrainingClassSessionAnswerSequence);
133                            }
134                        }
135                    }
136                }
137            }
138        }
139
140        return partyTrainingClassSessionAnswer;
141    }
142
143    @Override
144    public PartyTrainingClassSessionQuestion getLockEntity(PartyTrainingClassSessionAnswer partyTrainingClassSessionAnswer) {
145        return partyTrainingClassSessionAnswer.getPartyTrainingClassSessionQuestion();
146    }
147
148    @Override
149    public void fillInResult(EditPartyTrainingClassSessionAnswerResult result, PartyTrainingClassSessionAnswer partyTrainingClassSessionAnswer) {
150        var trainingControl = Session.getModelController(TrainingControl.class);
151
152        result.setPartyTrainingClassSessionAnswer(trainingControl.getPartyTrainingClassSessionAnswerTransfer(getUserVisit(), partyTrainingClassSessionAnswer));
153    }
154    
155    TrainingClassAnswer trainingClassAnswer;
156    
157    @Override
158    public void doLock(PartyTrainingClassSessionAnswerEdit edit, PartyTrainingClassSessionAnswer partyTrainingClassSessionAnswer) {
159        DateUtils dateUtils = DateUtils.getInstance();
160        UserVisit userVisit = getUserVisit();
161        DateTimeFormat preferredDateTimeFormat = getPreferredDateTimeFormat();
162        
163        trainingClassAnswer = partyTrainingClassSessionAnswer.getTrainingClassAnswer();
164        
165        edit.setTrainingClassAnswerName(trainingClassAnswer == null ? null : trainingClassAnswer.getLastDetail().getTrainingClassAnswerName());
166        edit.setQuestionStartTime(dateUtils.formatTypicalDateTime(userVisit, preferredDateTimeFormat, partyTrainingClassSessionAnswer.getQuestionStartTime()));
167        edit.setQuestionEndTime(dateUtils.formatTypicalDateTime(userVisit, preferredDateTimeFormat, partyTrainingClassSessionAnswer.getQuestionEndTime()));
168    }
169
170    Long questionStartTime;
171    Long questionEndTime;
172    
173    @Override
174    public void canUpdate(PartyTrainingClassSessionAnswer partyTrainingClassSessionAnswer) {
175        String trainingClassAnswerName = edit.getTrainingClassAnswerName();
176
177        trainingClassAnswer = trainingClassAnswerName == null ? null : TrainingClassLogic.getInstance().getTrainingClassAnswerByName(this,
178                partyTrainingClassSessionAnswer.getTrainingClassAnswer().getLastDetail().getTrainingClassQuestion(), trainingClassAnswerName);
179        
180        if(!hasExecutionErrors()) {
181            String strQuestionEndTime = edit.getQuestionEndTime();
182            
183            questionStartTime = Long.valueOf(edit.getQuestionStartTime());
184            questionEndTime = strQuestionEndTime == null ? null : Long.valueOf(strQuestionEndTime);
185        }
186    }
187
188    @Override
189    public void doUpdate(PartyTrainingClassSessionAnswer partyTrainingClassSessionAnswer) {
190        var trainingControl = Session.getModelController(TrainingControl.class);
191        var partyPK = getPartyPK();
192        PartyTrainingClassSessionAnswerValue partyTrainingClassSessionAnswerValue = trainingControl.getPartyTrainingClassSessionAnswerValue(partyTrainingClassSessionAnswer);
193
194        partyTrainingClassSessionAnswerValue.setTrainingClassAnswerPK(trainingClassAnswer == null ? null : trainingClassAnswer.getPrimaryKey());
195        partyTrainingClassSessionAnswerValue.setQuestionStartTime(questionStartTime);
196        partyTrainingClassSessionAnswerValue.setQuestionEndTime(questionEndTime);
197
198        trainingControl.updatePartyTrainingClassSessionAnswerFromValue(partyTrainingClassSessionAnswerValue, partyPK);
199    }
200
201}