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