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.form.GetPartyTrainingClassSessionForm;
020import com.echothree.control.user.training.common.result.TrainingResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
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.control.training.server.logic.PartyTrainingClassLogic;
027import com.echothree.model.data.training.server.entity.PartyTrainingClassSession;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetPartyTrainingClassSessionCommand
042        extends BaseSingleEntityCommand<PartyTrainingClassSession, GetPartyTrainingClassSessionForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.PartyTrainingClassSession.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("PartyTrainingClassName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("PartyTrainingClassSessionSequence", FieldType.UNSIGNED_INTEGER, true, null, null)
058        );
059    }
060
061    @Inject
062    TrainingControl trainingControl;
063
064    @Inject
065    PartyTrainingClassLogic partyTrainingClassLogic;
066
067
068    /** Creates a new instance of GetPartyTrainingClassSessionCommand */
069    public GetPartyTrainingClassSessionCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
071    }
072
073    
074    @Override
075    protected PartyTrainingClassSession getEntity() {
076        var partyTrainingClassName = form.getPartyTrainingClassName();
077        var partyTrainingClass = partyTrainingClassLogic.getPartyTrainingClassByName(this, partyTrainingClassName);
078        PartyTrainingClassSession partyTrainingClassSession = null;
079        
080        if(!hasExecutionErrors()) {
081            var partyTrainingClassSessionSequence = Integer.valueOf(form.getPartyTrainingClassSessionSequence());
082            partyTrainingClassSession = trainingControl.getPartyTrainingClassSessionBySequence(partyTrainingClass, partyTrainingClassSessionSequence);
083
084            if(partyTrainingClassSession != null) {
085                sendEvent(partyTrainingClassSession.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
086            } else {
087                addExecutionError(ExecutionErrors.UnknownPartyTrainingClassSessionSequence.name(), partyTrainingClassName, form.getPartyTrainingClassSessionSequence());
088            }
089        }
090
091        return partyTrainingClassSession;
092    }
093
094    @Override
095    protected BaseResult getResult(PartyTrainingClassSession partyTrainingClassSession) {
096        var result = TrainingResultFactory.getGetPartyTrainingClassSessionResult();
097
098        if(partyTrainingClassSession != null) {
099            result.setPartyTrainingClassSession(trainingControl.getPartyTrainingClassSessionTransfer(getUserVisit(), partyTrainingClassSession));
100        }
101
102        return result;
103    }
104    
105}