001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.GetLocationCapacitiesForm;
020import com.echothree.control.user.warehouse.common.result.WarehouseResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.warehouse.server.control.WarehouseControl;
025import com.echothree.model.control.warehouse.server.logic.WarehouseLogic;
026import com.echothree.model.data.warehouse.server.entity.Location;
027import com.echothree.model.data.warehouse.server.entity.LocationCapacity;
028import com.echothree.model.data.warehouse.server.factory.LocationCapacityFactory;
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.BasePaginatedMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetLocationCapacitiesCommand
044        extends BasePaginatedMultipleEntitiesCommand<LocationCapacity, GetLocationCapacitiesForm> {
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.LocationCapacity.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("LocationName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062    
063    @Inject
064    WarehouseControl warehouseControl;
065
066    @Inject
067    WarehouseLogic warehouseLogic;
068
069    /** Creates a new instance of GetLocationCapacitiesCommand */
070    public GetLocationCapacitiesCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
072    }
073
074    Location location;
075
076    @Override
077    protected void handleForm() {
078        var warehouseName = form.getWarehouseName();
079        var warehouse = warehouseLogic.getWarehouseByName(this, warehouseName, null, null, false);
080
081        if(!hasExecutionErrors()) {
082            var locationName = form.getLocationName();
083
084            location = warehouseControl.getLocationByName(warehouse.getParty(), locationName);
085
086            if(location == null) {
087                addExecutionError(ExecutionErrors.UnknownLocationName.name(), locationName);
088            }
089        }
090    }
091
092    @Override
093    protected Long getTotalEntities() {
094        return hasExecutionErrors() ? null : warehouseControl.countLocationCapacitiesByLocation(location);
095    }
096
097    @Override
098    protected Collection<LocationCapacity> getEntities() {
099        return hasExecutionErrors() ? null : warehouseControl.getLocationCapacitiesByLocation(location);
100    }
101
102    @Override
103    protected BaseResult getResult(Collection<LocationCapacity> entities) {
104        var result = WarehouseResultFactory.getGetLocationCapacitiesResult();
105
106        if(entities != null) {
107            var userVisit = getUserVisit();
108
109            result.setLocation(warehouseControl.getLocationTransfer(userVisit, location));
110
111            if(session.hasLimit(LocationCapacityFactory.class)) {
112                result.setLocationCapacityCount(getTotalEntities());
113            }
114
115            result.setLocationCapacities(warehouseControl.getLocationCapacityTransfers(userVisit, entities));
116        }
117
118        return result;
119    }
120
121}