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.PartyTrainingClassSessionPageEdit;
020import com.echothree.control.user.training.common.edit.TrainingEditFactory;
021import com.echothree.control.user.training.common.form.EditPartyTrainingClassSessionPageForm;
022import com.echothree.control.user.training.common.result.EditPartyTrainingClassSessionPageResult;
023import com.echothree.control.user.training.common.result.TrainingResultFactory;
024import com.echothree.control.user.training.common.spec.PartyTrainingClassSessionPageSpec;
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.PartyTrainingClassSessionPage;
036import com.echothree.model.data.training.server.entity.TrainingClassPage;
037import com.echothree.model.data.training.server.value.PartyTrainingClassSessionPageValue;
038import com.echothree.model.data.user.common.pk.UserVisitPK;
039import com.echothree.model.data.user.server.entity.UserVisit;
040import com.echothree.util.common.validation.FieldDefinition;
041import com.echothree.util.common.validation.FieldType;
042import com.echothree.util.common.command.EditMode;
043import com.echothree.util.server.control.BaseAbstractEditCommand;
044import com.echothree.util.server.control.CommandSecurityDefinition;
045import com.echothree.util.server.control.PartyTypeDefinition;
046import com.echothree.util.server.control.SecurityRoleDefinition;
047import com.echothree.util.server.persistence.Session;
048import com.echothree.util.server.string.DateUtils;
049import java.util.Arrays;
050import java.util.Collections;
051import java.util.List;
052
053public class EditPartyTrainingClassSessionPageCommand
054        extends BaseAbstractEditCommand<PartyTrainingClassSessionPageSpec, PartyTrainingClassSessionPageEdit, EditPartyTrainingClassSessionPageResult, PartyTrainingClassSessionPage, PartyTrainingClassSession> {
055    
056    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
057    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
058    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
059    
060    static {
061        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
062                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
063                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
064                        new SecurityRoleDefinition(SecurityRoleGroups.PartyTrainingClassSessionPage.name(), SecurityRoles.Edit.name())
065                        )))
066                )));
067
068        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
069                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, true, null, null),
070                new FieldDefinition("PartyTrainingClassSessionSequence", FieldType.UNSIGNED_INTEGER, true, null, null),
071                new FieldDefinition("PartyTrainingClassSessionPageSequence", FieldType.UNSIGNED_INTEGER, true, null, null)
072                ));
073
074        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
075                new FieldDefinition("TrainingClassPageName", FieldType.ENTITY_NAME, true, null, null),
076                new FieldDefinition("ReadingStartTime", FieldType.DATE_TIME, true, null, null),
077                new FieldDefinition("ReadingEndTime", FieldType.DATE_TIME, false, null, null)
078                ));
079    }
080    
081    /** Creates a new instance of EditPartyTrainingClassSessionPageCommand */
082    public EditPartyTrainingClassSessionPageCommand(UserVisitPK userVisitPK, EditPartyTrainingClassSessionPageForm form) {
083        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
084    }
085    
086    @Override
087    public EditPartyTrainingClassSessionPageResult getResult() {
088        return TrainingResultFactory.getEditPartyTrainingClassSessionPageResult();
089    }
090
091    @Override
092    public PartyTrainingClassSessionPageEdit getEdit() {
093        return TrainingEditFactory.getPartyTrainingClassSessionPageEdit();
094    }
095
096    @Override
097    public PartyTrainingClassSessionPage getEntity(EditPartyTrainingClassSessionPageResult result) {
098        PartyTrainingClassSessionPage partyTrainingClassSessionPage = null;
099        PartyTrainingClass partyTrainingClass = PartyTrainingClassLogic.getInstance().getPartyTrainingClassByName(this, spec.getPartyTrainingClassName());
100        
101        if(!hasExecutionErrors()) {
102            Integer partyTrainingClassSessionSequence = Integer.valueOf(spec.getPartyTrainingClassSessionSequence());
103            PartyTrainingClassSession partyTrainingClassSession = PartyTrainingClassSessionLogic.getInstance().getPartyTrainingClassSession(this,
104                    partyTrainingClass, partyTrainingClassSessionSequence);
105            
106            if(!hasExecutionErrors()) {
107                Integer partyTrainingClassSessionPageSequence = Integer.valueOf(spec.getPartyTrainingClassSessionPageSequence());
108                
109                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
110                    partyTrainingClassSessionPage = PartyTrainingClassSessionLogic.getInstance().getPartyTrainingClassSessionPage(this,
111                            partyTrainingClassSession, partyTrainingClassSessionPageSequence);
112                } else { // EditMode.UPDATE
113                    partyTrainingClassSessionPage = PartyTrainingClassSessionLogic.getInstance().getPartyTrainingClassSessionPageForUpdate(this,
114                            partyTrainingClassSession, partyTrainingClassSessionPageSequence);
115                }
116            }
117        }
118
119        return partyTrainingClassSessionPage;
120    }
121
122    @Override
123    public PartyTrainingClassSession getLockEntity(PartyTrainingClassSessionPage partyTrainingClassSessionPage) {
124        return partyTrainingClassSessionPage.getPartyTrainingClassSession();
125    }
126
127    @Override
128    public void fillInResult(EditPartyTrainingClassSessionPageResult result, PartyTrainingClassSessionPage partyTrainingClassSessionPage) {
129        var trainingControl = Session.getModelController(TrainingControl.class);
130
131        result.setPartyTrainingClassSessionPage(trainingControl.getPartyTrainingClassSessionPageTransfer(getUserVisit(), partyTrainingClassSessionPage));
132    }
133    
134    @Override
135    public void doLock(PartyTrainingClassSessionPageEdit edit, PartyTrainingClassSessionPage partyTrainingClassSessionPage) {
136        DateUtils dateUtils = DateUtils.getInstance();
137        UserVisit userVisit = getUserVisit();
138        DateTimeFormat preferredDateTimeFormat = getPreferredDateTimeFormat();
139        
140        edit.setTrainingClassPageName(partyTrainingClassSessionPage.getTrainingClassPage().getLastDetail().getTrainingClassPageName());
141        edit.setReadingStartTime(dateUtils.formatTypicalDateTime(userVisit, preferredDateTimeFormat, partyTrainingClassSessionPage.getReadingStartTime()));
142        edit.setReadingEndTime(dateUtils.formatTypicalDateTime(userVisit, preferredDateTimeFormat, partyTrainingClassSessionPage.getReadingEndTime()));
143    }
144
145    TrainingClassPage trainingClassPage;
146    Long readingStartTime;
147    Long readingEndTime;
148    
149    @Override
150    public void canUpdate(PartyTrainingClassSessionPage partyTrainingClassSessionPage) {
151        String strReadingEndTime = edit.getReadingEndTime();
152
153        trainingClassPage = TrainingClassLogic.getInstance().getTrainingClassPageByName(this,
154                partyTrainingClassSessionPage.getTrainingClassPage().getLastDetail().getTrainingClassSection(), edit.getTrainingClassPageName());
155        readingStartTime = Long.valueOf(edit.getReadingStartTime());
156        readingEndTime = strReadingEndTime == null ? null : Long.valueOf(strReadingEndTime);
157    }
158
159    @Override
160    public void doUpdate(PartyTrainingClassSessionPage partyTrainingClassSessionPage) {
161        var trainingControl = Session.getModelController(TrainingControl.class);
162        var partyPK = getPartyPK();
163        PartyTrainingClassSessionPageValue partyTrainingClassSessionPageValue = trainingControl.getPartyTrainingClassSessionPageValue(partyTrainingClassSessionPage);
164
165        partyTrainingClassSessionPageValue.setTrainingClassPagePK(trainingClassPage.getPrimaryKey());
166        partyTrainingClassSessionPageValue.setReadingStartTime(readingStartTime);
167        partyTrainingClassSessionPageValue.setReadingEndTime(readingEndTime);
168
169        trainingControl.updatePartyTrainingClassSessionPageFromValue(partyTrainingClassSessionPageValue, partyPK);
170    }
171
172}