001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.SetLocationStatusForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.control.warehouse.server.control.WarehouseControl;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class SetLocationStatusCommand
041        extends BaseSimpleCommand<SetLocationStatusForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.LocationStatus.name(), SecurityRoles.Choices.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("LocationName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("LocationStatusChoice", FieldType.ENTITY_NAME, true, null, null)
058                ));
059    }
060    
061    /** Creates a new instance of SetLocationStatusCommand */
062    public SetLocationStatusCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var warehouseControl = Session.getModelController(WarehouseControl.class);
069        var warehouseName = form.getWarehouseName();
070        var warehouse = warehouseControl.getWarehouseByName(warehouseName);
071        
072        if(warehouse != null) {
073            var warehouseParty = warehouse.getParty();
074            var locationName = form.getLocationName();
075            var location = warehouseControl.getLocationByName(warehouseParty, locationName);
076            
077            if(location != null) {
078                var locationStatusChoice = form.getLocationStatusChoice();
079                
080                warehouseControl.setLocationStatus(this, location, locationStatusChoice, getPartyPK());
081            } else {
082                addExecutionError(ExecutionErrors.UnknownLocationName.name(), locationName);
083            }
084        } else {
085            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
086        }
087        
088        return null;
089    }
090    
091}