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    /** Creates a new instance of EditPartyTrainingClassCommand */
071    public EditPartyTrainingClassCommand() {
072        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
073    }
074
075    @Inject
076    TrainingControl trainingControl;
077
078    @Inject
079    PartyTrainingClassLogic partyTrainingClassLogic;
080    
081    @Override
082    public EditPartyTrainingClassResult getResult() {
083        return TrainingResultFactory.getEditPartyTrainingClassResult();
084    }
085
086    @Override
087    public PartyTrainingClassEdit getEdit() {
088        return TrainingEditFactory.getPartyTrainingClassEdit();
089    }
090
091    @Override
092    public PartyTrainingClass getEntity(EditPartyTrainingClassResult result) {
093        var partyTrainingClassName = spec.getPartyTrainingClassName();
094        var partyTrainingClass = partyTrainingClassLogic.getPartyTrainingClassByName(this, partyTrainingClassName,
095                editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON) ? EntityPermission.READ_ONLY : EntityPermission.READ_WRITE);
096
097        if(!hasExecutionErrors()) {
098            result.setPartyTrainingClass(trainingControl.getPartyTrainingClassTransfer(getUserVisit(), partyTrainingClass));
099        }
100
101        return partyTrainingClass;
102    }
103
104    @Override
105    public PartyTrainingClass getLockEntity(PartyTrainingClass partyTrainingClass) {
106        return partyTrainingClass;
107    }
108
109    @Override
110    public void fillInResult(EditPartyTrainingClassResult result, PartyTrainingClass partyTrainingClass) {
111        result.setPartyTrainingClass(trainingControl.getPartyTrainingClassTransfer(getUserVisit(), partyTrainingClass));
112    }
113
114    @Override
115    public void doLock(PartyTrainingClassEdit edit, PartyTrainingClass partyTrainingClass) {
116        var dateUtils = DateUtils.getInstance();
117        var partyTrainingClassDetail = partyTrainingClass.getLastDetail();
118        var userVisit = getUserVisit();
119        var preferredDateTimeFormat = getPreferredDateTimeFormat();
120        
121        edit.setCompletedTime(dateUtils.formatTypicalDateTime(userVisit, preferredDateTimeFormat, partyTrainingClassDetail.getCompletedTime()));
122        edit.setValidUntilTime(dateUtils.formatTypicalDateTime(userVisit, preferredDateTimeFormat, partyTrainingClassDetail.getValidUntilTime()));
123    }
124
125    Long completedTime;
126    Long validUntilTime;
127    
128    @Override
129    public void canUpdate(PartyTrainingClass partyTrainingClass) {
130        var strCompletedTime = edit.getCompletedTime();
131        
132        completedTime = strCompletedTime == null ? null : Long.valueOf(strCompletedTime);
133
134        if(completedTime == null || completedTime < session.getStartTime()) {
135            var strValidUntilTime = edit.getValidUntilTime();
136            
137            validUntilTime = strValidUntilTime == null ? null : Long.valueOf(strValidUntilTime);
138
139            if(validUntilTime != null && validUntilTime <= session.getStartTime()) {
140                addExecutionError(ExecutionErrors.InvalidValidUntilTime.name());
141            }
142        } else {
143            addExecutionError(ExecutionErrors.InvalidCompletedTime.name());
144        }
145    }
146
147    @Override
148    public void doUpdate(PartyTrainingClass partyTrainingClass) {
149        var partyPK = getPartyPK();
150        var partyTrainingClassDetailValue = trainingControl.getPartyTrainingClassDetailValueForUpdate(partyTrainingClass);
151
152        partyTrainingClassDetailValue.setCompletedTime(completedTime);
153        partyTrainingClassDetailValue.setValidUntilTime(validUntilTime);
154
155        partyTrainingClassLogic.updatePartyTrainingClassFromValue(partyTrainingClassDetailValue, partyPK);
156    }
157
158}