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.GetLocationNameElementsForm;
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.warehouse.server.entity.LocationNameElement;
026import com.echothree.model.data.warehouse.server.entity.LocationType;
027import com.echothree.model.data.warehouse.server.entity.Warehouse;
028import com.echothree.model.data.warehouse.server.factory.LocationNameElementFactory;
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 GetLocationNameElementsCommand
044        extends BasePaginatedMultipleEntitiesCommand<LocationNameElement, GetLocationNameElementsForm> {
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.LocationNameElement.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("LocationTypeName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    @Inject
064    WarehouseControl warehouseControl;
065
066    
067    /** Creates a new instance of GetLocationNameElementsCommand */
068    public GetLocationNameElementsCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
070    }
071
072    private Warehouse warehouse;
073    private LocationType locationType;
074
075    @Override
076    protected void handleForm() {
077        var warehouseName = form.getWarehouseName();
078
079        warehouse = warehouseControl.getWarehouseByName(warehouseName);
080
081        if(warehouse != null) {
082            var warehouseParty = warehouse.getParty();
083            var locationTypeName = form.getLocationTypeName();
084
085            locationType = warehouseControl.getLocationTypeByName(warehouseParty, locationTypeName);
086
087            if(locationType == null) {
088                addExecutionError(ExecutionErrors.UnknownLocationTypeName.name(), locationTypeName);
089            }
090        } else {
091            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
092        }
093    }
094
095    @Override
096    protected Long getTotalEntities() {
097        return locationType == null ? null : warehouseControl.countLocationNameElementsByLocationType(locationType);
098    }
099
100    @Override
101    protected Collection<LocationNameElement> getEntities() {
102        return locationType == null ? null : warehouseControl.getLocationNameElementsByLocationType(locationType);
103    }
104
105    @Override
106    protected BaseResult getResult(Collection<LocationNameElement> entities) {
107        var result = WarehouseResultFactory.getGetLocationNameElementsResult();
108
109        if(entities != null) {
110            result.setWarehouse(warehouseControl.getWarehouseTransfer(getUserVisit(), warehouse));
111            result.setLocationType(warehouseControl.getLocationTypeTransfer(getUserVisit(), locationType));
112
113            if(session.hasLimit(LocationNameElementFactory.class)) {
114                result.setLocationNameElementCount(getTotalEntities());
115            }
116
117            result.setLocationNameElements(warehouseControl.getLocationNameElementTransfers(getUserVisit(), entities));
118        }
119
120        return result;
121    }
122
123}