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.GetCarrierOptionChoicesForm;
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.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetCarrierOptionChoicesCommand
040        extends BaseSimpleCommand<GetCarrierOptionChoicesForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierOption.name(), SecurityRoles.Choices.name())
049                ))
050        ));
051
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("DefaultCarrierOptionChoice", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
056        );
057    }
058
059    @Inject
060    CarrierControl carrierControl;
061
062    
063    /** Creates a new instance of GetCarrierOptionChoicesCommand */
064    public GetCarrierOptionChoicesCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var result = CarrierResultFactory.getGetCarrierOptionChoicesResult();
071        var carrierName = form.getCarrierName();
072        var carrier = carrierControl.getCarrierByName(carrierName);
073        
074        if(carrier != null) {
075            var carrierParty = carrier.getParty();
076            var defaultCarrierOptionChoice = form.getDefaultCarrierOptionChoice();
077            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
078            
079            result.setCarrierOptionChoices(carrierControl.getCarrierOptionChoices(defaultCarrierOptionChoice, getPreferredLanguage(), allowNullChoice,
080                    carrierParty));
081        } else {
082            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
083        }
084        
085        return result;
086    }
087    
088}