001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.GetLocationNameElementResult;
021import com.echothree.control.user.warehouse.common.result.WarehouseResultFactory;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.control.warehouse.server.control.WarehouseControl;
027import com.echothree.model.data.party.server.entity.Party;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.model.data.warehouse.server.entity.LocationNameElement;
030import com.echothree.model.data.warehouse.server.entity.LocationType;
031import com.echothree.model.data.warehouse.server.entity.Warehouse;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class GetLocationNameElementCommand
046        extends BaseSimpleCommand<GetLocationNameElementForm> {
047
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.LocationNameElement.name(), SecurityRoles.Review.name())
056                ))
057        ));
058
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060            new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
061            new FieldDefinition("LocationTypeName", FieldType.ENTITY_NAME, true, null, null),
062            new FieldDefinition("LocationNameElementName", FieldType.ENTITY_NAME, true, null, null)
063        ));
064    }
065    
066    /** Creates a new instance of GetLocationNameElementCommand */
067    public GetLocationNameElementCommand(UserVisitPK userVisitPK, GetLocationNameElementForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var warehouseControl = Session.getModelController(WarehouseControl.class);
074        GetLocationNameElementResult result = WarehouseResultFactory.getGetLocationNameElementResult();
075        String warehouseName = form.getWarehouseName();
076        Warehouse warehouse = warehouseControl.getWarehouseByName(warehouseName);
077        
078        if(warehouse != null) {
079            Party warehouseParty = warehouse.getParty();
080            String locationTypeName = form.getLocationTypeName();
081            LocationType locationType = warehouseControl.getLocationTypeByName(warehouseParty, locationTypeName);
082
083            if(locationType != null) {
084                String locationNameElementName = form.getLocationNameElementName();
085                LocationNameElement locationNameElement = warehouseControl.getLocationNameElementByName(locationType, locationNameElementName);
086
087                if(locationNameElement != null) {
088                    result.setLocationNameElement(warehouseControl.getLocationNameElementTransfer(getUserVisit(), locationNameElement));
089
090                    sendEvent(locationNameElement.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
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}