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.GetLocationsForm;
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.data.party.server.entity.Party;
026import com.echothree.model.data.warehouse.server.entity.Location;
027import com.echothree.model.data.warehouse.server.entity.Warehouse;
028import com.echothree.model.data.warehouse.server.factory.LocationFactory;
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 GetLocationsCommand
044        extends BasePaginatedMultipleEntitiesCommand<Location, GetLocationsForm> {
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.Location.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null)
059                );
060    }
061    
062    /** Creates a new instance of GetLocationsCommand */
063    public GetLocationsCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Inject
068    WarehouseControl warehouseControl;
069
070    private Warehouse warehouse;
071    private Party warehouseParty;
072
073    @Override
074    protected void handleForm() {
075        var warehouseName = form.getWarehouseName();
076
077        warehouse = warehouseControl.getWarehouseByName(warehouseName);
078
079        if(warehouse != null) {
080            warehouseParty = warehouse.getParty();
081        } else {
082            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
083        }
084    }
085
086    @Override
087    protected Long getTotalEntities() {
088        return warehouseParty == null ? null : warehouseControl.countLocationsByWarehouseParty(warehouseParty);
089    }
090
091    @Override
092    protected Collection<Location> getEntities() {
093        return warehouseParty == null ? null : warehouseControl.getLocationsByWarehouseParty(warehouseParty);
094    }
095
096    @Override
097    protected BaseResult getResult(Collection<Location> entities) {
098        var result = WarehouseResultFactory.getGetLocationsResult();
099
100        if(entities != null) {
101            result.setWarehouse(warehouseControl.getWarehouseTransfer(getUserVisit(), warehouse));
102
103            if(session.hasLimit(LocationFactory.class)) {
104                result.setLocationCount(getTotalEntities());
105            }
106
107            result.setLocations(warehouseControl.getLocationTransfers(getUserVisit(), entities));
108        }
109
110        return result;
111    }
112
113}