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.CreateLocationVolumeForm;
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.common.UomConstants;
024import com.echothree.model.control.uom.server.control.UomControl;
025import com.echothree.model.control.uom.server.util.Conversion;
026import com.echothree.model.control.warehouse.server.control.WarehouseControl;
027import com.echothree.model.data.uom.server.entity.UnitOfMeasureKind;
028import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.model.data.warehouse.server.entity.Location;
031import com.echothree.model.data.warehouse.server.entity.LocationVolume;
032import com.echothree.model.data.warehouse.server.entity.Warehouse;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.server.control.BaseSimpleCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import com.echothree.util.server.persistence.Session;
042import java.util.Arrays;
043import java.util.Collections;
044import java.util.List;
045
046public class CreateLocationVolumeCommand
047        extends BaseSimpleCommand<CreateLocationVolumeForm> {
048
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
056                        new SecurityRoleDefinition(SecurityRoleGroups.LocationVolume.name(), SecurityRoles.Create.name())
057                ))
058        ));
059
060        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
061                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LocationName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("HeightUnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("Height", FieldType.UNSIGNED_LONG, true, null, null),
065                new FieldDefinition("WidthUnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("Width", FieldType.UNSIGNED_LONG, true, null, null),
067                new FieldDefinition("DepthUnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("Depth", FieldType.UNSIGNED_LONG, true, null, null)
069                ));
070    }
071    
072    /** Creates a new instance of CreateLocationVolumeCommand */
073    public CreateLocationVolumeCommand(UserVisitPK userVisitPK, CreateLocationVolumeForm form) {
074        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
075    }
076    
077    @Override
078    protected BaseResult execute() {
079        var warehouseControl = Session.getModelController(WarehouseControl.class);
080        String warehouseName = form.getWarehouseName();
081        Warehouse warehouse = warehouseControl.getWarehouseByName(warehouseName);
082        
083        if(warehouse != null) {
084            String locationName = form.getLocationName();
085            Location location = warehouseControl.getLocationByName(warehouse.getParty(), locationName);
086            
087            if(location != null) {
088                LocationVolume locationVolume = warehouseControl.getLocationVolume(location);
089                
090                if(locationVolume == null) {
091                    var uomControl = Session.getModelController(UomControl.class);
092                    UnitOfMeasureKind volumeUnitOfMeasureKind = uomControl.getUnitOfMeasureKindByUnitOfMeasureKindUseTypeUsingNames(UomConstants.UnitOfMeasureKindUseType_VOLUME);
093                    
094                    if(volumeUnitOfMeasureKind != null) {
095                        String heightUnitOfMeasureTypeName = form.getHeightUnitOfMeasureTypeName();
096                        UnitOfMeasureType heightUnitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(volumeUnitOfMeasureKind,
097                                heightUnitOfMeasureTypeName);
098                        
099                        if(heightUnitOfMeasureType != null) {
100                            Long height = Long.valueOf(form.getHeight());
101                            String widthUnitOfMeasureTypeName = form.getWidthUnitOfMeasureTypeName();
102                            UnitOfMeasureType widthUnitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(volumeUnitOfMeasureKind,
103                                    widthUnitOfMeasureTypeName);
104                            
105                            if(widthUnitOfMeasureType != null) {
106                                Long width = Long.valueOf(form.getWidth());
107                                String depthUnitOfMeasureTypeName = form.getDepthUnitOfMeasureTypeName();
108                                UnitOfMeasureType depthUnitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(volumeUnitOfMeasureKind,
109                                        depthUnitOfMeasureTypeName);
110                                
111                                if(depthUnitOfMeasureType != null) {
112                                    Long depth = Long.valueOf(form.getDepth());
113                                    Conversion heightConversion = new Conversion(uomControl, heightUnitOfMeasureType, height).convertToLowestUnitOfMeasureType();
114                                    Conversion widthConversion = new Conversion(uomControl, widthUnitOfMeasureType, width).convertToLowestUnitOfMeasureType();
115                                    Conversion depthConversion = new Conversion(uomControl, depthUnitOfMeasureType, depth).convertToLowestUnitOfMeasureType();
116                                    
117                                    warehouseControl.createLocationVolume(location, heightConversion.getQuantity(),
118                                            widthConversion.getQuantity(), depthConversion.getQuantity(), getPartyPK());
119                                } else {
120                                    addExecutionError(ExecutionErrors.UnknownDepthUnitOfMeasureTypeName.name(), depthUnitOfMeasureTypeName);
121                                }
122                            } else {
123                                addExecutionError(ExecutionErrors.UnknownWidthUnitOfMeasureTypeName.name(), widthUnitOfMeasureTypeName);
124                            }
125                        } else {
126                            addExecutionError(ExecutionErrors.UnknownHeightUnitOfMeasureTypeName.name(), heightUnitOfMeasureTypeName);
127                        }
128                    } else {
129                        addExecutionError(ExecutionErrors.UnknownVolumeUnitOfMeasureKind.name());
130                    }
131                } else {
132                    addExecutionError(ExecutionErrors.DuplicateLocationVolume.name());
133                }
134            } else {
135                addExecutionError(ExecutionErrors.UnknownLocationName.name(), locationName);
136            }
137        } else {
138            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
139        }
140        
141        return null;
142    }
143    
144}