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.GetLocationNameElementForm;
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.LocationNameElement;
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 GetLocationNameElementCommand
042        extends BaseSingleEntityCommand<LocationNameElement, GetLocationNameElementForm> {
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.LocationNameElement.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("LocationTypeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LocationNameElementName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061    
062    /** Creates a new instance of GetLocationNameElementCommand */
063    public GetLocationNameElementCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066
067    @Inject
068    WarehouseControl warehouseControl;
069
070    @Inject
071    WarehouseLogic warehouseLogic;
072
073    @Override
074    protected LocationNameElement getEntity() {
075        var warehouse = warehouseLogic.getWarehouseByName(this, form.getWarehouseName(), null, null, false);
076        LocationNameElement entity = null;
077
078        if(!hasExecutionErrors()) {
079            var warehouseParty = warehouse.getParty();
080            var locationTypeName = form.getLocationTypeName();
081            var locationType = warehouseControl.getLocationTypeByName(warehouseParty, locationTypeName);
082
083            if(locationType != null) {
084                var locationNameElementName = form.getLocationNameElementName();
085
086                entity = warehouseControl.getLocationNameElementByName(locationType, locationNameElementName);
087
088                if(entity != null) {
089                    sendEvent(entity.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
090                } else {
091                    addExecutionError(ExecutionErrors.UnknownLocationNameElementName.name(), warehouse.getWarehouseName(),
092                            locationType.getLastDetail().getLocationTypeName(), locationNameElementName);
093                }
094            } else {
095                addExecutionError(ExecutionErrors.UnknownLocationTypeName.name(), warehouse.getWarehouseName(), locationTypeName);
096            }
097        }
098
099        return entity;
100    }
101
102    @Override
103    protected BaseResult getResult(LocationNameElement entity) {
104        var result = WarehouseResultFactory.getGetLocationNameElementResult();
105
106        if(entity != null) {
107            result.setLocationNameElement(warehouseControl.getLocationNameElementTransfer(getUserVisit(), entity));
108        }
109
110        return result;
111    }
112    
113}