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.workrequirement.server.command;
018
019import com.echothree.control.user.workrequirement.common.form.GetWorkRequirementScopesForm;
020import com.echothree.control.user.workrequirement.common.result.WorkRequirementResultFactory;
021import com.echothree.model.control.workeffort.server.control.WorkEffortControl;
022import com.echothree.model.control.workrequirement.server.control.WorkRequirementControl;
023import com.echothree.model.data.workeffort.server.entity.WorkEffortScope;
024import com.echothree.model.data.workrequirement.server.entity.WorkRequirementScope;
025import com.echothree.model.data.workrequirement.server.entity.WorkRequirementType;
026import com.echothree.model.data.workrequirement.server.factory.WorkRequirementScopeFactory;
027import com.echothree.util.common.command.BaseResult;
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.BasePaginatedMultipleEntitiesCommand;
032import java.util.Collection;
033import java.util.List;
034import javax.enterprise.context.Dependent;
035import javax.inject.Inject;
036
037@Dependent
038public class GetWorkRequirementScopesCommand
039        extends BasePaginatedMultipleEntitiesCommand<WorkRequirementScope, GetWorkRequirementScopesForm> {
040    
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        FORM_FIELD_DEFINITIONS = List.of(
045                new FieldDefinition("WorkEffortTypeName", FieldType.ENTITY_NAME, true, null, null),
046                new FieldDefinition("WorkRequirementTypeName", FieldType.ENTITY_NAME, false, null, null),
047                new FieldDefinition("WorkEffortScopeName", FieldType.ENTITY_NAME, false, null, null)
048        );
049    }
050
051    @Inject
052    WorkEffortControl workEffortControl;
053
054    @Inject
055    WorkRequirementControl workRequirementControl;
056
057
058    /** Creates a new instance of GetWorkRequirementScopesCommand */
059    public GetWorkRequirementScopesCommand() {
060        super(null, FORM_FIELD_DEFINITIONS, true);
061    }
062
063    private WorkRequirementType workRequirementType;
064    private WorkEffortScope workEffortScope;
065
066    @Override
067    protected void handleForm() {
068        var workEffortTypeName = form.getWorkEffortTypeName();
069        var workEffortType = workEffortControl.getWorkEffortTypeByName(workEffortTypeName);
070
071        if(workEffortType != null) {
072            var workEffortScopeName = form.getWorkEffortScopeName();
073            var workRequirementTypeName = form.getWorkRequirementTypeName();
074            var parameterCount = (workEffortScopeName == null ? 0 : 1) + (workRequirementTypeName == null ? 0 : 1);
075
076            if(parameterCount == 1) {
077                if(workEffortScopeName != null) {
078                    workEffortScope = workEffortControl.getWorkEffortScopeByName(workEffortType, workEffortScopeName);
079
080                    if(workEffortScope == null) {
081                        addExecutionError(ExecutionErrors.UnknownWorkEffortScopeName.name(), workEffortScopeName);
082                    }
083                } else {
084                    workRequirementType = workRequirementControl.getWorkRequirementTypeByName(workEffortType, workRequirementTypeName);
085
086                    if(workRequirementType == null) {
087                        addExecutionError(ExecutionErrors.UnknownWorkRequirementTypeName.name(), workRequirementTypeName);
088                    }
089                }
090            } else {
091                addExecutionError(ExecutionErrors.InvalidParameterCount.name());
092            }
093        } else {
094            addExecutionError(ExecutionErrors.UnknownWorkEffortTypeName.name(), workEffortTypeName);
095        }
096    }
097
098    @Override
099    protected Long getTotalEntities() {
100        Long totalEntities = null;
101
102        if(!hasExecutionErrors()) {
103            if(workEffortScope != null) {
104                totalEntities = workRequirementControl.countWorkRequirementScopesByWorkEffortScope(workEffortScope);
105            } else {
106                totalEntities = workRequirementControl.countWorkRequirementScopesByWorkRequirementType(workRequirementType);
107            }
108        }
109
110        return totalEntities;
111    }
112
113    @Override
114    protected Collection<WorkRequirementScope> getEntities() {
115        Collection<WorkRequirementScope> entities = null;
116
117        if(!hasExecutionErrors()) {
118            if(workEffortScope != null) {
119                entities = workRequirementControl.getWorkRequirementScopesByWorkEffortScope(workEffortScope);
120            } else {
121                entities = workRequirementControl.getWorkRequirementScopesByWorkRequirementType(workRequirementType);
122            }
123        }
124
125        return entities;
126    }
127
128    @Override
129    protected BaseResult getResult(Collection<WorkRequirementScope> entities) {
130        var result = WorkRequirementResultFactory.getGetWorkRequirementScopesResult();
131
132        if(entities != null) {
133            var userVisit = getUserVisit();
134
135            if(workEffortScope != null) {
136                result.setWorkEffortScope(workEffortControl.getWorkEffortScopeTransfer(userVisit, workEffortScope));
137            } else {
138                result.setWorkRequirementType(workRequirementControl.getWorkRequirementTypeTransfer(userVisit, workRequirementType));
139            }
140
141            if(session.hasLimit(WorkRequirementScopeFactory.class)) {
142                result.setWorkRequirementScopeCount(getTotalEntities());
143            }
144
145            result.setWorkRequirementScopes(workRequirementControl.getWorkRequirementScopeTransfers(userVisit, entities));
146        }
147
148        return result;
149    }
150
151}