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