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.GetLocationChoicesForm;
020import com.echothree.control.user.warehouse.common.result.GetLocationChoicesResult;
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.Warehouse;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class GetLocationChoicesCommand
043        extends BaseSimpleCommand<GetLocationChoicesForm> {
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.Location.name(), SecurityRoles.Choices.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("DefaultLocationChoice", FieldType.ENTITY_NAME, false, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetLocationChoicesCommand */
063    public GetLocationChoicesCommand(UserVisitPK userVisitPK, GetLocationChoicesForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var warehouseControl = Session.getModelController(WarehouseControl.class);
070        GetLocationChoicesResult result = WarehouseResultFactory.getGetLocationChoicesResult();
071        String warehouseName = form.getWarehouseName();
072        Warehouse warehouse = warehouseControl.getWarehouseByName(warehouseName);
073        
074        if(warehouse != null) {
075            String defaultLocationChoice = form.getDefaultLocationChoice();
076            Party warehouseParty = warehouse.getParty();
077            
078            result.setLocationChoices(warehouseControl.getLocationChoicesByWarehouseParty(defaultLocationChoice,
079            getPreferredLanguage(), warehouseParty));
080        } else {
081            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
082        }
083        
084        return result;
085    }
086    
087}