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.item.server.command;
018
019import com.echothree.control.user.item.common.form.GetItemVolumeForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.item.server.control.ItemControl;
022import com.echothree.model.control.item.server.logic.ItemLogic;
023import com.echothree.model.control.item.server.logic.ItemVolumeTypeLogic;
024import com.echothree.model.control.uom.server.logic.UnitOfMeasureTypeLogic;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import java.util.List;
031import javax.enterprise.context.Dependent;
032import javax.inject.Inject;
033
034@Dependent
035public class GetItemVolumeCommand
036        extends BaseSimpleCommand<GetItemVolumeForm> {
037
038    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = List.of(
043                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
044                new FieldDefinition("UnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
045                new FieldDefinition("ItemVolumeTypeName", FieldType.ENTITY_NAME, true, null, null)
046        );
047    }
048    
049    @Inject
050    ItemControl itemControl;
051
052    @Inject
053    ItemLogic itemLogic;
054
055    @Inject
056    ItemVolumeTypeLogic itemVolumeTypeLogic;
057
058    @Inject
059    UnitOfMeasureTypeLogic unitOfMeasureTypeLogic;
060
061    /** Creates a new instance of GetItemVolumeCommand */
062    public GetItemVolumeCommand() {
063        super(null, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var result = ItemResultFactory.getGetItemVolumeResult();
069        var item = itemLogic.getItemByName(this, form.getItemName());
070
071        if(!hasExecutionErrors()) {
072            var unitOfMeasureTypeName = form.getUnitOfMeasureTypeName();
073            var unitOfMeasureKind = item.getLastDetail().getUnitOfMeasureKind();
074            var unitOfMeasureType = unitOfMeasureTypeLogic.getUnitOfMeasureTypeByName(this, unitOfMeasureKind, unitOfMeasureTypeName);
075
076            if(!hasExecutionErrors()) {
077                var itemVolumeType = itemVolumeTypeLogic.getItemVolumeTypeByName(this, form.getItemVolumeTypeName());
078
079                if(!hasExecutionErrors()) {
080                    var itemVolume = itemControl.getItemVolume(item, unitOfMeasureType, itemVolumeType);
081
082                    if(itemVolume != null) {
083                        result.setItemVolume(itemControl.getItemVolumeTransfer(getUserVisit(), itemVolume));
084                    } else {
085                        addExecutionError(ExecutionErrors.UnknownItemVolume.name(), item.getLastDetail().getItemName(),
086                                unitOfMeasureType.getLastDetail().getUnitOfMeasureTypeName(),
087                                itemVolumeType.getLastDetail().getItemVolumeTypeName());
088                    }
089                }
090            }
091        }
092
093        return result;
094    }
095    
096}