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.warehouse.server.command;
018
019import com.echothree.control.user.warehouse.common.form.GetLocationForm;
020import com.echothree.control.user.warehouse.common.result.WarehouseResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.warehouse.server.control.WarehouseControl;
026import com.echothree.model.control.warehouse.server.logic.WarehouseLogic;
027import com.echothree.model.data.warehouse.server.entity.Location;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetLocationCommand
042        extends BaseSingleEntityCommand<Location, GetLocationForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.Location.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("LocationName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060    
061    /** Creates a new instance of GetLocationCommand */
062    public GetLocationCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065
066    @Inject
067    WarehouseControl warehouseControl;
068
069    @Inject
070    WarehouseLogic warehouseLogic;
071
072    @Override
073    protected Location getEntity() {
074        var warehouse = warehouseLogic.getWarehouseByName(this, form.getWarehouseName(), null, null, false);
075        Location location = null;
076
077        if(!hasExecutionErrors()) {
078            var warehouseParty = warehouse.getParty();
079            var locationName = form.getLocationName();
080
081            location = warehouseControl.getLocationByName(warehouseParty, locationName);
082
083            if(location != null) {
084                sendEvent(location.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
085            } else {
086                addExecutionError(ExecutionErrors.UnknownLocationName.name(), warehouse.getWarehouseName(), locationName);
087            }
088        }
089
090        return location;
091    }
092
093    @Override
094    protected BaseResult getResult(Location location) {
095        var result = WarehouseResultFactory.getGetLocationResult();
096
097        if(location != null) {
098            var userVisit = getUserVisit();
099
100            result.setLocation(warehouseControl.getLocationTransfer(userVisit, location));
101            result.setLocationNameElements(warehouseControl.getLocationNameElementTransfersByLocationType(userVisit,
102                    location.getActiveDetail().getLocationType()));
103            result.setLocationVolume(warehouseControl.getLocationVolumeTransfer(userVisit, location));
104            result.setLocationCapacities(warehouseControl.getLocationCapacityTransfersByLocation(userVisit, location));
105        }
106
107        return result;
108    }
109
110}