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.CreateLocationCapacityForm;
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.uom.server.control.UomControl;
024import com.echothree.model.control.warehouse.server.control.WarehouseControl;
025import com.echothree.model.data.uom.server.entity.UnitOfMeasureKind;
026import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
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.LocationCapacity;
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 CreateLocationCapacityCommand
045        extends BaseSimpleCommand<CreateLocationCapacityForm> {
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.LocationCapacity.name(), SecurityRoles.Create.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("LocationName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("UnitOfMeasureKindName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("UnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("Capacity", FieldType.UNSIGNED_LONG, true, null, null)
064                ));
065    }
066    
067    /** Creates a new instance of CreateLocationCapacityCommand */
068    public CreateLocationCapacityCommand(UserVisitPK userVisitPK, CreateLocationCapacityForm form) {
069        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var warehouseControl = Session.getModelController(WarehouseControl.class);
075        String warehouseName = form.getWarehouseName();
076        Warehouse warehouse = warehouseControl.getWarehouseByName(warehouseName);
077        
078        if(warehouse != null) {
079            String locationName = form.getLocationName();
080            Location location = warehouseControl.getLocationByName(warehouse.getParty(), locationName);
081            
082            if(location != null) {
083                var uomControl = Session.getModelController(UomControl.class);
084                String unitOfMeasureKindName = form.getUnitOfMeasureKindName();
085                UnitOfMeasureKind unitOfMeasureKind = uomControl.getUnitOfMeasureKindByName(unitOfMeasureKindName);
086                
087                if(unitOfMeasureKind != null) {
088                    String unitOfMeasureTypeName = form.getUnitOfMeasureTypeName();
089                    UnitOfMeasureType unitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(unitOfMeasureKind, unitOfMeasureTypeName);
090                    
091                    if(unitOfMeasureType != null) {
092                        LocationCapacity locationCapacity = warehouseControl.getLocationCapacity(location, unitOfMeasureType);
093                        
094                        if(locationCapacity == null) {
095                            Long capacity = Long.valueOf(form.getCapacity());
096                            
097                            warehouseControl.createLocationCapacity(location, unitOfMeasureType, capacity, getPartyPK());
098                        } else {
099                            addExecutionError(ExecutionErrors.DuplicateLocationCapacity.name());
100                        }
101                    } else {
102                        addExecutionError(ExecutionErrors.UnknownUnitOfMeasureTypeName.name(), unitOfMeasureTypeName);
103                    }
104                } else {
105                    addExecutionError(ExecutionErrors.UnknownUnitOfMeasureKindName.name(), unitOfMeasureKindName);
106                }
107            } else {
108                addExecutionError(ExecutionErrors.UnknownLocationName.name(), locationName);
109            }
110        } else {
111            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
112        }
113        
114        return null;
115    }
116    
117}