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.security.server.command;
018
019import com.echothree.control.user.security.common.form.GetPartySecurityRoleTemplateTrainingClassForm;
020import com.echothree.control.user.security.common.result.GetPartySecurityRoleTemplateTrainingClassResult;
021import com.echothree.control.user.security.common.result.SecurityResultFactory;
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.security.server.control.SecurityControl;
026import com.echothree.model.control.training.server.control.TrainingControl;
027import com.echothree.model.data.security.server.entity.PartySecurityRoleTemplate;
028import com.echothree.model.data.security.server.entity.PartySecurityRoleTemplateTrainingClass;
029import com.echothree.model.data.training.server.entity.TrainingClass;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class GetPartySecurityRoleTemplateTrainingClassCommand
045        extends BaseSimpleCommand<GetPartySecurityRoleTemplateTrainingClassForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.PartySecurityRoleTemplateTrainingClass.name(), SecurityRoles.Review.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("PartySecurityRoleTemplateName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetPartySecurityRoleTemplateTrainingClassCommand */
065    public GetPartySecurityRoleTemplateTrainingClassCommand(UserVisitPK userVisitPK, GetPartySecurityRoleTemplateTrainingClassForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var securityControl = Session.getModelController(SecurityControl.class);
072        GetPartySecurityRoleTemplateTrainingClassResult result = SecurityResultFactory.getGetPartySecurityRoleTemplateTrainingClassResult();
073        String partySecurityRoleTemplateName = form.getPartySecurityRoleTemplateName();
074        PartySecurityRoleTemplate partySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByName(partySecurityRoleTemplateName);
075        
076        if(partySecurityRoleTemplate != null) {
077            var trainingControl = Session.getModelController(TrainingControl.class);
078            String trainingClassName = form.getTrainingClassName();
079            TrainingClass trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
080            
081            if(trainingClass != null) {
082                PartySecurityRoleTemplateTrainingClass partySecurityRoleTemplateTrainingClass = securityControl.getPartySecurityRoleTemplateTrainingClass(partySecurityRoleTemplate,
083                        trainingClass);
084
085                if(partySecurityRoleTemplateTrainingClass != null) {
086                    result.setPartySecurityRoleTemplateTrainingClass(securityControl.getPartySecurityRoleTemplateTrainingClassTransfer(getUserVisit(),
087                            partySecurityRoleTemplateTrainingClass));
088                } else {
089                    addExecutionError(ExecutionErrors.UnknownPartySecurityRoleTemplateTrainingClass.name(), partySecurityRoleTemplateName, trainingClassName);
090                }
091            } else {
092                addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
093            }
094        } else {
095            addExecutionError(ExecutionErrors.UnknownPartySecurityRoleTemplateName.name(), partySecurityRoleTemplateName);
096        }
097        
098        return result;
099    }
100    
101}