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.GetItemVolumesForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.item.server.control.ItemControl;
022import com.echothree.util.common.command.BaseResult;
023import com.echothree.util.common.message.ExecutionErrors;
024import com.echothree.util.common.validation.FieldDefinition;
025import com.echothree.util.common.validation.FieldType;
026import com.echothree.util.server.control.BaseSimpleCommand;
027import com.echothree.util.server.persistence.Session;
028import java.util.List;
029import javax.enterprise.context.RequestScoped;
030
031@RequestScoped
032public class GetItemVolumesCommand
033        extends BaseSimpleCommand<GetItemVolumesForm> {
034
035    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037    
038    static {
039        FORM_FIELD_DEFINITIONS = List.of(
040                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null)
041        );
042    }
043    
044    /** Creates a new instance of GetItemVolumesCommand */
045    public GetItemVolumesCommand() {
046        super(null, FORM_FIELD_DEFINITIONS, true);
047    }
048    
049    @Override
050    protected BaseResult execute() {
051        var itemControl = Session.getModelController(ItemControl.class);
052        var result = ItemResultFactory.getGetItemVolumesResult();
053        var itemName = form.getItemName();
054        var item = itemControl.getItemByName(itemName);
055        
056        if(item != null) {
057            var userVisit = getUserVisit();
058            
059            result.setItem(itemControl.getItemTransfer(userVisit, item));
060            result.setItemVolumes(itemControl.getItemVolumeTransfersByItem(userVisit, item));
061        } else {
062            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
063        }
064        
065        return result;
066    }
067    
068}