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