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