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