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.GetLocationDescriptionsForm;
020import com.echothree.control.user.warehouse.common.result.GetLocationDescriptionsResult;
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.Location;
029import com.echothree.model.data.warehouse.server.entity.Warehouse;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class GetLocationDescriptionsCommand
044        extends BaseSimpleCommand<GetLocationDescriptionsForm> {
045
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.Location.name(), SecurityRoles.Description.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("LocationName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetLocationDescriptionsCommand */
064    public GetLocationDescriptionsCommand(UserVisitPK userVisitPK, GetLocationDescriptionsForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var warehouseControl = Session.getModelController(WarehouseControl.class);
071        GetLocationDescriptionsResult result = WarehouseResultFactory.getGetLocationDescriptionsResult();
072        String warehouseName = form.getWarehouseName();
073        Warehouse warehouse = warehouseControl.getWarehouseByName(warehouseName);
074        
075        if(warehouse != null) {
076            Party warehouseParty = warehouse.getParty();
077            String locationName = form.getLocationName();
078            Location location = warehouseControl.getLocationByName(warehouseParty, locationName);
079            
080            result.setWarehouse(warehouseControl.getWarehouseTransfer(getUserVisit(), warehouse));
081            
082            if(location != null) {
083                result.setLocation(warehouseControl.getLocationTransfer(getUserVisit(), location));
084                result.setLocationDescriptions(warehouseControl.getLocationDescriptionTransfersByLocation(getUserVisit(), location));
085            } else {
086                addExecutionError(ExecutionErrors.UnknownLocationName.name(), locationName);
087            }
088        } else {
089            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
090        }
091        
092        return result;
093    }
094    
095}