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.form.SetPartyTrainingClassStatusForm;
020import com.echothree.control.user.training.common.result.SetPartyTrainingClassStatusResult;
021import com.echothree.control.user.training.common.result.TrainingResultFactory;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.training.server.control.TrainingControl;
026import com.echothree.model.data.training.server.entity.PartyTrainingClass;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSetStatusCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class SetPartyTrainingClassStatusCommand
041        extends BaseSetStatusCommand<SetPartyTrainingClassStatusForm, SetPartyTrainingClassStatusResult, PartyTrainingClass, PartyTrainingClass> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
049                    new SecurityRoleDefinition(SecurityRoleGroups.PartyTrainingClassStatus.name(), SecurityRoles.Choices.name())
050                    )))
051                )));
052        
053        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
054                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("PartyTrainingClassStatusChoice", FieldType.ENTITY_NAME, true, null, null)
056                ));
057    }
058    
059    /** Creates a new instance of SetPartyTrainingClassStatusCommand */
060    public SetPartyTrainingClassStatusCommand(UserVisitPK userVisitPK, SetPartyTrainingClassStatusForm form) {
061        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS);
062    }
063    
064    @Override
065    public SetPartyTrainingClassStatusResult getResult() {
066        return TrainingResultFactory.getSetPartyTrainingClassStatusResult();
067    }
068
069    @Override
070    public PartyTrainingClass getEntity() {
071        var trainingControl = Session.getModelController(TrainingControl.class);
072        String partyTrainingClassName = form.getPartyTrainingClassName();
073        PartyTrainingClass partyTrainingClass = trainingControl.getPartyTrainingClassByNameForUpdate(partyTrainingClassName);
074
075        if(partyTrainingClass == null) {
076            addExecutionError(ExecutionErrors.UnknownPartyTrainingClass.name(), partyTrainingClassName);
077        }
078
079        return partyTrainingClass;
080    }
081
082    @Override
083    public PartyTrainingClass getLockEntity(PartyTrainingClass partyTrainingClass) {
084        return partyTrainingClass;
085    }
086
087    @Override
088    public void doUpdate(PartyTrainingClass partyTrainingClass) {
089        var trainingControl = Session.getModelController(TrainingControl.class);
090        String partyTrainingClassStatusChoice = form.getPartyTrainingClassStatusChoice();
091
092        trainingControl.setPartyTrainingClassStatus(this, partyTrainingClass, partyTrainingClassStatusChoice, getPartyPK());
093    }
094    
095}