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.security.server.command;
018
019import com.echothree.control.user.security.common.form.GetPartySecurityRoleTemplateTrainingClassForm;
020import com.echothree.control.user.security.common.result.SecurityResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.security.server.control.SecurityControl;
025import com.echothree.model.control.security.server.logic.PartySecurityRoleTemplateLogic;
026import com.echothree.model.control.training.server.logic.TrainingClassLogic;
027import com.echothree.model.data.security.server.entity.PartySecurityRoleTemplateTrainingClass;
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 GetPartySecurityRoleTemplateTrainingClassCommand
042        extends BaseSingleEntityCommand<PartySecurityRoleTemplateTrainingClass, GetPartySecurityRoleTemplateTrainingClassForm> {
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.PartySecurityRoleTemplateTrainingClass.name(), SecurityRoles.Review.name())
052                ))
053        ));
054        
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("PartySecurityRoleTemplateName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060
061    @Inject
062    SecurityControl securityControl;
063
064    @Inject
065    PartySecurityRoleTemplateLogic partySecurityRoleTemplateLogic;
066
067    @Inject
068    TrainingClassLogic trainingClassLogic;
069
070
071    /** Creates a new instance of GetPartySecurityRoleTemplateTrainingClassCommand */
072    public GetPartySecurityRoleTemplateTrainingClassCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
074    }
075    
076    @Override
077    protected PartySecurityRoleTemplateTrainingClass getEntity() {
078        PartySecurityRoleTemplateTrainingClass partySecurityRoleTemplateTrainingClass = null;
079        var partySecurityRoleTemplateName = form.getPartySecurityRoleTemplateName();
080        var partySecurityRoleTemplate = partySecurityRoleTemplateLogic.getPartySecurityRoleTemplateByName(this, partySecurityRoleTemplateName);
081
082        if(!hasExecutionErrors()) {
083            var trainingClassName = form.getTrainingClassName();
084            var trainingClass = trainingClassLogic.getTrainingClassByName(this, trainingClassName, false);
085
086            if(!hasExecutionErrors()) {
087                partySecurityRoleTemplateTrainingClass = securityControl.getPartySecurityRoleTemplateTrainingClass(partySecurityRoleTemplate, trainingClass);
088
089                if(partySecurityRoleTemplateTrainingClass == null) {
090                    addExecutionError(ExecutionErrors.UnknownPartySecurityRoleTemplateTrainingClass.name(), partySecurityRoleTemplateName, trainingClassName);
091                }
092            }
093        }
094
095        return partySecurityRoleTemplateTrainingClass;
096    }
097
098    @Override
099    protected BaseResult getResult(PartySecurityRoleTemplateTrainingClass partySecurityRoleTemplateTrainingClass) {
100        var result = SecurityResultFactory.getGetPartySecurityRoleTemplateTrainingClassResult();
101
102        if(partySecurityRoleTemplateTrainingClass != null) {
103            result.setPartySecurityRoleTemplateTrainingClass(securityControl.getPartySecurityRoleTemplateTrainingClassTransfer(getUserVisit(),
104                    partySecurityRoleTemplateTrainingClass));
105        }
106
107        return result;
108    }
109    
110}