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.inventory.server.command;
018
019import com.echothree.control.user.inventory.common.form.GetInventoryCostingMethodForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.inventory.server.control.InventoryCostingMethodControl;
023import com.echothree.model.control.inventory.server.logic.InventoryCostingMethodLogic;
024import com.echothree.model.data.inventory.server.entity.InventoryCostingMethod;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSingleEntityCommand;
030import java.util.List;
031import javax.inject.Inject;
032import javax.enterprise.context.Dependent;
033
034@Dependent
035public class GetInventoryCostingMethodCommand
036        extends BaseSingleEntityCommand<InventoryCostingMethod, GetInventoryCostingMethodForm> {
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("InventoryCostingMethodName", FieldType.ENTITY_NAME, false, null, null),
044                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
045                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
046        );
047    }
048
049    @Inject
050    InventoryCostingMethodControl inventoryCostingMethodControl;
051
052    @Inject
053    InventoryCostingMethodLogic inventoryCostingMethodLogic;
054
055    /** Creates a new instance of GetInventoryCostingMethodCommand */
056    public GetInventoryCostingMethodCommand() {
057        super(null, FORM_FIELD_DEFINITIONS, true);
058    }
059
060    @Override
061    protected InventoryCostingMethod getEntity() {
062        var inventoryCostingMethod = inventoryCostingMethodLogic.getInventoryCostingMethodByUniversalSpec(this, form, true);
063
064        if(inventoryCostingMethod != null) {
065            sendEvent(inventoryCostingMethod.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
066        }
067
068        return inventoryCostingMethod;
069    }
070
071    @Override
072    protected BaseResult getResult(InventoryCostingMethod itemAliasType) {
073        var result = InventoryResultFactory.getGetInventoryCostingMethodResult();
074
075        if(itemAliasType != null) {
076            result.setInventoryCostingMethod(inventoryCostingMethodControl.getInventoryCostingMethodTransfer(getUserVisit(), itemAliasType));
077        }
078
079        return result;
080    }
081
082}