001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.SetDefaultCarrierOptionForm;
020import com.echothree.model.control.carrier.server.control.CarrierControl;
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.data.carrier.server.entity.Carrier;
025import com.echothree.model.data.carrier.server.value.CarrierOptionDetailValue;
026import com.echothree.model.data.party.server.entity.Party;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class SetDefaultCarrierOptionCommand
042        extends BaseSimpleCommand<SetDefaultCarrierOptionForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierOption.name(), SecurityRoles.Edit.name())
051                        )))
052                )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("CarrierOptionName", FieldType.ENTITY_NAME, true, null, null)
057                ));
058    }
059    
060    /** Creates a new instance of SetDefaultCarrierOptionCommand */
061    public SetDefaultCarrierOptionCommand(UserVisitPK userVisitPK, SetDefaultCarrierOptionForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var carrierControl = Session.getModelController(CarrierControl.class);
068        String carrierName = form.getCarrierName();
069        Carrier carrier = carrierControl.getCarrierByName(carrierName);
070        
071        if(carrier != null) {
072            Party carrierParty = carrier.getParty();
073            String carrierOptionName = form.getCarrierOptionName();
074            CarrierOptionDetailValue carrierOptionDetailValue = carrierControl.getCarrierOptionDetailValueByNameForUpdate(carrierParty, carrierOptionName);
075            
076            if(carrierOptionDetailValue != null) {
077                carrierOptionDetailValue.setIsDefault(Boolean.TRUE);
078                carrierControl.updateCarrierOptionFromValue(carrierOptionDetailValue, getPartyPK());
079            } else {
080                addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName);
081            }
082        } else {
083            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
084        }
085        
086        return null;
087    }
088    
089}