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.workrequirement.server.command;
018
019import com.echothree.control.user.workrequirement.common.form.GetWorkRequirementScopeForm;
020import com.echothree.control.user.workrequirement.common.result.GetWorkRequirementScopeResult;
021import com.echothree.control.user.workrequirement.common.result.WorkRequirementResultFactory;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.control.workeffort.server.control.WorkEffortControl;
024import com.echothree.model.control.workrequirement.server.control.WorkRequirementControl;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.model.data.workeffort.server.entity.WorkEffortScope;
027import com.echothree.model.data.workeffort.server.entity.WorkEffortType;
028import com.echothree.model.data.workrequirement.server.entity.WorkRequirementScope;
029import com.echothree.model.data.workrequirement.server.entity.WorkRequirementType;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class GetWorkRequirementScopeCommand
041        extends BaseSimpleCommand<GetWorkRequirementScopeForm> {
042    
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
047            new FieldDefinition("WorkEffortTypeName", FieldType.ENTITY_NAME, true, null, null),
048            new FieldDefinition("WorkRequirementTypeName", FieldType.ENTITY_NAME, true, null, null),
049            new FieldDefinition("WorkEffortScopeName", FieldType.ENTITY_NAME, true, null, null)
050        ));
051    }
052    
053    /** Creates a new instance of GetWorkRequirementScopeCommand */
054    public GetWorkRequirementScopeCommand(UserVisitPK userVisitPK, GetWorkRequirementScopeForm form) {
055        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
056    }
057    
058    @Override
059    protected BaseResult execute() {
060        var workEffortControl = Session.getModelController(WorkEffortControl.class);
061        GetWorkRequirementScopeResult result = WorkRequirementResultFactory.getGetWorkRequirementScopeResult();
062        String workEffortTypeName = form.getWorkEffortTypeName();
063        WorkEffortType workEffortType = workEffortControl.getWorkEffortTypeByName(workEffortTypeName);
064        
065        if(workEffortType != null) {
066            String workEffortScopeName = form.getWorkEffortScopeName();
067            WorkEffortScope workEffortScope = workEffortControl.getWorkEffortScopeByName(workEffortType, workEffortScopeName);
068            
069            if(workEffortScope != null) {
070                var workRequirementControl = Session.getModelController(WorkRequirementControl.class);
071                String workRequirementTypeName = form.getWorkRequirementTypeName();
072                WorkRequirementType workRequirementType = workRequirementControl.getWorkRequirementTypeByName(workEffortType, workRequirementTypeName);
073                
074                if(workRequirementType != null) {
075                    WorkRequirementScope workRequirementScope = workRequirementControl.getWorkRequirementScope(workEffortScope, workRequirementType);
076                    
077                    result.setWorkRequirementScope(workRequirementControl.getWorkRequirementScopeTransfer(getUserVisit(), workRequirementScope));
078                    
079                    sendEvent(workRequirementType.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
080                } else {
081                    addExecutionError(ExecutionErrors.UnknownWorkRequirementTypeName.name(), workRequirementTypeName);
082                }
083            } else {
084                addExecutionError(ExecutionErrors.UnknownWorkEffortScopeName.name(), workEffortScopeName);
085            }
086        } else {
087            addExecutionError(ExecutionErrors.UnknownWorkEffortTypeName.name(), workEffortTypeName);
088        }
089        
090        return result;
091    }
092    
093}