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.GetLocationNameElementDescriptionsForm;
020import com.echothree.control.user.warehouse.common.result.WarehouseResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.warehouse.server.control.WarehouseControl;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSimpleCommand;
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 GetLocationNameElementDescriptionsCommand
040        extends BaseSimpleCommand<GetLocationNameElementDescriptionsForm> {
041
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044
045    static {
046        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.LocationNameElement.name(), SecurityRoles.Description.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("LocationTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("LocationNameElementName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059
060    @Inject
061    WarehouseControl warehouseControl;
062
063    
064    /** Creates a new instance of GetLocationNameElementDescriptionsCommand */
065    public GetLocationNameElementDescriptionsCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var result = WarehouseResultFactory.getGetLocationNameElementDescriptionsResult();
072        var warehouseName = form.getWarehouseName();
073        var warehouse = warehouseControl.getWarehouseByName(warehouseName);
074        
075        if(warehouse != null) {
076            var warehouseParty = warehouse.getParty();
077            var locationTypeName = form.getLocationTypeName();
078            var locationType = warehouseControl.getLocationTypeByName(warehouseParty, locationTypeName);
079            
080            result.setWarehouse(warehouseControl.getWarehouseTransfer(getUserVisit(), warehouse));
081            
082            if(locationType != null) {
083                var locationNameElementName = form.getLocationNameElementName();
084                var locationNameElement = warehouseControl.getLocationNameElementByName(locationType, locationNameElementName);
085                
086                result.setLocationType(warehouseControl.getLocationTypeTransfer(getUserVisit(), locationType));
087                
088                if(locationNameElement != null) {
089                    result.setLocationNameElement(warehouseControl.getLocationNameElementTransfer(getUserVisit(), locationNameElement));
090                    result.setLocationNameElementDescriptions(warehouseControl.getLocationNameElementDescriptionTransfersByLocationNameElement(getUserVisit(), locationNameElement));
091                } else {
092                    addExecutionError(ExecutionErrors.UnknownLocationNameElementName.name(), locationNameElementName);
093                }
094            } else {
095                addExecutionError(ExecutionErrors.UnknownLocationTypeName.name(), locationTypeName);
096            }
097        } else {
098            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
099        }
100        
101        return result;
102    }
103    
104}