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.GetInventoryLocationBucketForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.inventory.server.control.BucketControl;
022import com.echothree.model.control.inventory.server.logic.InventoryBucketTypeLogic;
023import com.echothree.model.control.inventory.server.logic.InventoryLocationLogic;
024import com.echothree.model.control.item.server.logic.ItemLogic;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.warehouse.server.logic.LocationLogic;
029import com.echothree.model.data.inventory.server.entity.InventoryLocationBucket;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.server.control.BaseSingleEntityCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetInventoryLocationBucketCommand
044        extends BaseSingleEntityCommand<InventoryLocationBucket, GetInventoryLocationBucketForm> {
045
046    private static final CommandSecurityDefinition COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047            new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048            new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                    new SecurityRoleDefinition(SecurityRoleGroups.InventoryLocationBucket.name(), SecurityRoles.Review.name())
050            ))
051    ));
052
053    private static final List<FieldDefinition> FORM_FIELD_DEFINITIONS = List.of(
054            new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
055            new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, false, null, null),
056            new FieldDefinition("LocationName", FieldType.ENTITY_NAME, true, null, null),
057            new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
058            new FieldDefinition("InventoryBucketTypeName", FieldType.ENTITY_NAME, true, null, null)
059    );
060
061    @Inject
062    BucketControl bucketControl;
063
064    @Inject
065    LocationLogic locationLogic;
066
067    @Inject
068    ItemLogic itemLogic;
069
070    @Inject
071    InventoryLocationLogic inventoryLocationLogic;
072
073    @Inject
074    InventoryBucketTypeLogic inventoryBucketTypeLogic;
075
076    public GetInventoryLocationBucketCommand() {
077        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
078    }
079
080    @Override
081    protected InventoryLocationBucket getEntity() {
082        InventoryLocationBucket inventoryLocationBucket = null;
083        var location = locationLogic.getLocation(this, form);
084        var item = itemLogic.getItemByName(this, form.getItemName());
085        var inventoryBucketType = inventoryBucketTypeLogic.getInventoryBucketTypeByName(this,
086                form.getInventoryBucketTypeName());
087
088        if(!hasExecutionErrors()) {
089            var inventoryLocation = inventoryLocationLogic.getInventoryLocation(this, location, item);
090
091            if(!hasExecutionErrors()) {
092                inventoryLocationBucket = bucketControl.getInventoryLocationBucket(inventoryLocation, inventoryBucketType);
093
094                if(inventoryLocationBucket == null) {
095                    addExecutionError(ExecutionErrors.UnknownInventoryLocationBucket.name(),
096                            location.getLastDetail().getLocationName(), item.getLastDetail().getItemName(),
097                            inventoryBucketType.getLastDetail().getInventoryBucketTypeName());
098                }
099            }
100        }
101
102        return inventoryLocationBucket;
103    }
104
105    @Override
106    protected BaseResult getResult(InventoryLocationBucket inventoryLocationBucket) {
107        var result = InventoryResultFactory.getGetInventoryLocationBucketResult();
108
109        if(inventoryLocationBucket != null) {
110            result.setInventoryLocationBucket(bucketControl.getInventoryLocationBucketTransfer(getUserVisit(),
111                    inventoryLocationBucket));
112        }
113
114        return result;
115    }
116
117}