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.carrier.server.command;
018
019import com.echothree.control.user.carrier.common.form.GetCarrierServicesForm;
020import com.echothree.control.user.carrier.common.result.CarrierResultFactory;
021import com.echothree.model.control.carrier.server.control.CarrierControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.carrier.server.entity.Carrier;
026import com.echothree.model.data.carrier.server.entity.CarrierService;
027import com.echothree.model.data.carrier.server.factory.CarrierServiceFactory;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetCarrierServicesCommand
043        extends BasePaginatedMultipleEntitiesCommand<CarrierService, GetCarrierServicesForm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierService.name(), SecurityRoles.List.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060
061    @Inject
062    CarrierControl carrierControl;
063
064    /** Creates a new instance of GetCarrierServicesCommand */
065    public GetCarrierServicesCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068
069    Carrier carrier;
070
071    @Override
072    protected void handleForm() {
073        var carrierName = form.getCarrierName();
074
075        carrier = carrierControl.getCarrierByName(carrierName);
076
077        if(carrier == null) {
078            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
079        }
080    }
081
082    @Override
083    protected Long getTotalEntities() {
084        return carrier == null ? null : carrierControl.countCarrierServicesByCarrierParty(carrier.getParty());
085    }
086
087    @Override
088    protected Collection<CarrierService> getEntities() {
089        return carrier == null ? null : carrierControl.getCarrierServices(carrier.getParty());
090    }
091
092    @Override
093    protected BaseResult getResult(Collection<CarrierService> entities) {
094        var result = CarrierResultFactory.getGetCarrierServicesResult();
095
096        if(carrier != null) {
097            var userVisit = getUserVisit();
098
099            result.setCarrier(carrierControl.getCarrierTransfer(userVisit, carrier));
100
101            if(session.hasLimit(CarrierServiceFactory.class)) {
102                result.setCarrierServiceCount(getTotalEntities());
103            }
104
105            result.setCarrierServices(carrierControl.getCarrierServiceTransfers(userVisit, entities));
106        }
107
108        return result;
109    }
110
111}