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    /** Creates a new instance of GetWorkRequirementScopesCommand */
058    public GetWorkRequirementScopesCommand() {
059        super(null, FORM_FIELD_DEFINITIONS, true);
060    }
061
062    private WorkRequirementType workRequirementType;
063    private WorkEffortScope workEffortScope;
064
065    @Override
066    protected void handleForm() {
067        var workEffortTypeName = form.getWorkEffortTypeName();
068        var workEffortType = workEffortControl.getWorkEffortTypeByName(workEffortTypeName);
069
070        if(workEffortType != null) {
071            var workEffortScopeName = form.getWorkEffortScopeName();
072            var workRequirementTypeName = form.getWorkRequirementTypeName();
073            var parameterCount = (workEffortScopeName == null ? 0 : 1) + (workRequirementTypeName == null ? 0 : 1);
074
075            if(parameterCount == 1) {
076                if(workEffortScopeName != null) {
077                    workEffortScope = workEffortControl.getWorkEffortScopeByName(workEffortType, workEffortScopeName);
078
079                    if(workEffortScope == null) {
080                        addExecutionError(ExecutionErrors.UnknownWorkEffortScopeName.name(), workEffortScopeName);
081                    }
082                } else {
083                    workRequirementType = workRequirementControl.getWorkRequirementTypeByName(workEffortType, workRequirementTypeName);
084
085                    if(workRequirementType == null) {
086                        addExecutionError(ExecutionErrors.UnknownWorkRequirementTypeName.name(), workRequirementTypeName);
087                    }
088                }
089            } else {
090                addExecutionError(ExecutionErrors.InvalidParameterCount.name());
091            }
092        } else {
093            addExecutionError(ExecutionErrors.UnknownWorkEffortTypeName.name(), workEffortTypeName);
094        }
095    }
096
097    @Override
098    protected Long getTotalEntities() {
099        Long totalEntities = null;
100
101        if(!hasExecutionErrors()) {
102            if(workEffortScope != null) {
103                totalEntities = workRequirementControl.countWorkRequirementScopesByWorkEffortScope(workEffortScope);
104            } else {
105                totalEntities = workRequirementControl.countWorkRequirementScopesByWorkRequirementType(workRequirementType);
106            }
107        }
108
109        return totalEntities;
110    }
111
112    @Override
113    protected Collection<WorkRequirementScope> getEntities() {
114        Collection<WorkRequirementScope> entities = null;
115
116        if(!hasExecutionErrors()) {
117            if(workEffortScope != null) {
118                entities = workRequirementControl.getWorkRequirementScopesByWorkEffortScope(workEffortScope);
119            } else {
120                entities = workRequirementControl.getWorkRequirementScopesByWorkRequirementType(workRequirementType);
121            }
122        }
123
124        return entities;
125    }
126
127    @Override
128    protected BaseResult getResult(Collection<WorkRequirementScope> entities) {
129        var result = WorkRequirementResultFactory.getGetWorkRequirementScopesResult();
130
131        if(entities != null) {
132            var userVisit = getUserVisit();
133
134            if(workEffortScope != null) {
135                result.setWorkEffortScope(workEffortControl.getWorkEffortScopeTransfer(userVisit, workEffortScope));
136            } else {
137                result.setWorkRequirementType(workRequirementControl.getWorkRequirementTypeTransfer(userVisit, workRequirementType));
138            }
139
140            if(session.hasLimit(WorkRequirementScopeFactory.class)) {
141                result.setWorkRequirementScopeCount(getTotalEntities());
142            }
143
144            result.setWorkRequirementScopes(workRequirementControl.getWorkRequirementScopeTransfers(userVisit, entities));
145        }
146
147        return result;
148    }
149
150}