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