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.edit.PartyTrainingClassEdit;
020import com.echothree.control.user.training.common.edit.TrainingEditFactory;
021import com.echothree.control.user.training.common.form.EditPartyTrainingClassForm;
022import com.echothree.control.user.training.common.result.EditPartyTrainingClassResult;
023import com.echothree.control.user.training.common.result.TrainingResultFactory;
024import com.echothree.control.user.training.common.spec.PartyTrainingClassSpec;
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.data.training.server.entity.PartyTrainingClass;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.EditMode;
036import com.echothree.util.server.control.BaseAbstractEditCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import com.echothree.util.server.string.DateUtils;
042import java.util.List;
043import javax.enterprise.context.Dependent;
044
045@Dependent
046public class EditPartyTrainingClassCommand
047        extends BaseAbstractEditCommand<PartyTrainingClassSpec, PartyTrainingClassEdit, EditPartyTrainingClassResult, PartyTrainingClass, PartyTrainingClass> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.PartyTrainingClass.name(), SecurityRoles.Edit.name())
058                        ))
059                ));
060
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, true, null, null)
063                );
064
065        EDIT_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("CompletedTime", FieldType.DATE_TIME, false, null, null),
067                new FieldDefinition("ValidUntilTime", FieldType.DATE_TIME, false, null, null)
068                );
069    }
070    
071    /** Creates a new instance of EditPartyTrainingClassCommand */
072    public EditPartyTrainingClassCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075    
076    @Override
077    public EditPartyTrainingClassResult getResult() {
078        return TrainingResultFactory.getEditPartyTrainingClassResult();
079    }
080
081    @Override
082    public PartyTrainingClassEdit getEdit() {
083        return TrainingEditFactory.getPartyTrainingClassEdit();
084    }
085
086    @Override
087    public PartyTrainingClass getEntity(EditPartyTrainingClassResult result) {
088        var trainingControl = Session.getModelController(TrainingControl.class);
089        PartyTrainingClass partyTrainingClass;
090        var partyTrainingClassName = spec.getPartyTrainingClassName();
091
092        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093            partyTrainingClass = trainingControl.getPartyTrainingClassByName(partyTrainingClassName);
094        } else { // EditMode.UPDATE
095            partyTrainingClass = trainingControl.getPartyTrainingClassByNameForUpdate(partyTrainingClassName);
096        }
097
098        if(partyTrainingClass != null) {
099            result.setPartyTrainingClass(trainingControl.getPartyTrainingClassTransfer(getUserVisit(), partyTrainingClass));
100        } else {
101            addExecutionError(ExecutionErrors.UnknownPartyTrainingClassName.name(), partyTrainingClassName);
102        }
103
104        return partyTrainingClass;
105    }
106
107    @Override
108    public PartyTrainingClass getLockEntity(PartyTrainingClass partyTrainingClass) {
109        return partyTrainingClass;
110    }
111
112    @Override
113    public void fillInResult(EditPartyTrainingClassResult result, PartyTrainingClass partyTrainingClass) {
114        var trainingControl = Session.getModelController(TrainingControl.class);
115
116        result.setPartyTrainingClass(trainingControl.getPartyTrainingClassTransfer(getUserVisit(), partyTrainingClass));
117    }
118
119    @Override
120    public void doLock(PartyTrainingClassEdit edit, PartyTrainingClass partyTrainingClass) {
121        var dateUtils = DateUtils.getInstance();
122        var partyTrainingClassDetail = partyTrainingClass.getLastDetail();
123        var userVisit = getUserVisit();
124        var preferredDateTimeFormat = getPreferredDateTimeFormat();
125        
126        edit.setCompletedTime(dateUtils.formatTypicalDateTime(userVisit, preferredDateTimeFormat, partyTrainingClassDetail.getCompletedTime()));
127        edit.setValidUntilTime(dateUtils.formatTypicalDateTime(userVisit, preferredDateTimeFormat, partyTrainingClassDetail.getValidUntilTime()));
128    }
129
130    Long completedTime;
131    Long validUntilTime;
132    
133    @Override
134    public void canUpdate(PartyTrainingClass partyTrainingClass) {
135        var strCompletedTime = edit.getCompletedTime();
136        
137        completedTime = strCompletedTime == null ? null : Long.valueOf(strCompletedTime);
138
139        if(completedTime == null || completedTime < session.getStartTime()) {
140            var strValidUntilTime = edit.getValidUntilTime();
141            
142            validUntilTime = strValidUntilTime == null ? null : Long.valueOf(strValidUntilTime);
143
144            if(validUntilTime != null && validUntilTime <= session.getStartTime()) {
145                addExecutionError(ExecutionErrors.InvalidValidUntilTime.name());
146            }
147        } else {
148            addExecutionError(ExecutionErrors.InvalidCompletedTime.name());
149        }
150    }
151
152    @Override
153    public void doUpdate(PartyTrainingClass partyTrainingClass) {
154        var trainingControl = Session.getModelController(TrainingControl.class);
155        var partyPK = getPartyPK();
156        var partyTrainingClassDetailValue = trainingControl.getPartyTrainingClassDetailValueForUpdate(partyTrainingClass);
157
158        partyTrainingClassDetailValue.setCompletedTime(completedTime);
159        partyTrainingClassDetailValue.setValidUntilTime(validUntilTime);
160
161        PartyTrainingClassLogic.getInstance().updatePartyTrainingClassFromValue(partyTrainingClassDetailValue, partyPK);
162    }
163
164}