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.GetInventoryLayerForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.inventory.server.control.InventoryLayerControl;
022import com.echothree.model.control.inventory.server.logic.InventoryLayerLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.inventory.server.entity.InventoryLayer;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSingleEntityCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetInventoryLayerCommand
040        extends BaseSingleEntityCommand<InventoryLayer, GetInventoryLayerForm> {
041
042    private static final CommandSecurityDefinition COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
043            new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
044            new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
045                    new SecurityRoleDefinition(SecurityRoleGroups.InventoryLayer.name(), SecurityRoles.Review.name())
046            ))
047    ));
048
049    private static final List<FieldDefinition> FORM_FIELD_DEFINITIONS = List.of(
050            new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
051            new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, false, null, null),
052            new FieldDefinition("ItemName", FieldType.ENTITY_NAME, false, null, null),
053            new FieldDefinition("InventoryConditionName", FieldType.ENTITY_NAME, false, null, null),
054            new FieldDefinition("InventoryLayerSequence", FieldType.UNSIGNED_INTEGER, false, null, null),
055            new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
056            new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
057    );
058
059    @Inject
060    InventoryLayerControl inventoryLayerControl;
061
062    @Inject
063    InventoryLayerLogic inventoryLayerLogic;
064
065    public GetInventoryLayerCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068
069    @Override
070    protected InventoryLayer getEntity() {
071        return inventoryLayerLogic.getInventoryLayerByUniversalSpec(this, form);
072    }
073
074    @Override
075    protected BaseResult getResult(InventoryLayer inventoryLayer) {
076        var result = InventoryResultFactory.getGetInventoryLayerResult();
077
078        if(!hasExecutionErrors()) {
079            result.setInventoryLayer(inventoryLayerControl.getInventoryLayerTransfer(getUserVisit(), inventoryLayer));
080        }
081
082        return result;
083    }
084
085}