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.GetLocationStatusChoicesForm;
020import com.echothree.control.user.warehouse.common.result.GetLocationStatusChoicesResult;
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 GetLocationStatusChoicesCommand
044        extends BaseSimpleCommand<GetLocationStatusChoicesForm> {
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.LocationStatus.name(), SecurityRoles.Choices.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                new FieldDefinition("DefaultLocationStatusChoice", FieldType.ENTITY_NAME, false, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetLocationStatusChoicesCommand */
065    public GetLocationStatusChoicesCommand(UserVisitPK userVisitPK, GetLocationStatusChoicesForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        GetLocationStatusChoicesResult result = WarehouseResultFactory.getGetLocationStatusChoicesResult();
072        var warehouseControl = Session.getModelController(WarehouseControl.class);
073        String warehouseName = form.getWarehouseName();
074        Warehouse warehouse = warehouseControl.getWarehouseByName(warehouseName);
075        
076        if(warehouse != null) {
077            Party warehouseParty = warehouse.getParty();
078            String locationName = form.getLocationName();
079            Location location = warehouseControl.getLocationByName(warehouseParty, locationName);
080            
081            if(location != null) {
082                String defaultLocationStatusChoice = form.getDefaultLocationStatusChoice();
083                
084                result.setLocationStatusChoices(warehouseControl.getLocationStatusChoices(defaultLocationStatusChoice,
085                        getPreferredLanguage(), location, getPartyPK()));
086            } else {
087                addExecutionError(ExecutionErrors.UnknownLocationName.name(), locationName);
088            }
089        } else {
090            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
091        }
092        
093        return result;
094    }
095    
096}