001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetLocationNameElementCommand
043        extends BaseSimpleCommand<GetLocationNameElementForm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.LocationNameElement.name(), SecurityRoles.Review.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057            new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
058            new FieldDefinition("LocationTypeName", FieldType.ENTITY_NAME, true, null, null),
059            new FieldDefinition("LocationNameElementName", FieldType.ENTITY_NAME, true, null, null)
060        ));
061    }
062    
063    /** Creates a new instance of GetLocationNameElementCommand */
064    public GetLocationNameElementCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var warehouseControl = Session.getModelController(WarehouseControl.class);
071        var result = WarehouseResultFactory.getGetLocationNameElementResult();
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            if(locationType != null) {
081                var locationNameElementName = form.getLocationNameElementName();
082                var locationNameElement = warehouseControl.getLocationNameElementByName(locationType, locationNameElementName);
083
084                if(locationNameElement != null) {
085                    result.setLocationNameElement(warehouseControl.getLocationNameElementTransfer(getUserVisit(), locationNameElement));
086
087                    sendEvent(locationNameElement.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
088                } else {
089                    addExecutionError(ExecutionErrors.UnknownLocationNameElementName.name(), locationNameElementName);
090                }
091            } else {
092                addExecutionError(ExecutionErrors.UnknownLocationTypeName.name(), locationTypeName);
093            }
094        } else {
095            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
096        }
097        
098        return result;
099    }
100    
101}