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.CreateCarrierOptionDescriptionForm;
020import com.echothree.model.control.carrier.server.control.CarrierControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
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.CarrierOption;
027import com.echothree.model.data.carrier.server.entity.CarrierOptionDescription;
028import com.echothree.model.data.party.server.entity.Language;
029import com.echothree.model.data.party.server.entity.Party;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class CreateCarrierOptionDescriptionCommand
045        extends BaseSimpleCommand<CreateCarrierOptionDescriptionForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierOption.name(), SecurityRoles.Description.name())
055                        )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("CarrierOptionName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
063                ));
064    }
065    
066    /** Creates a new instance of CreateCarrierOptionDescriptionCommand */
067    public CreateCarrierOptionDescriptionCommand(UserVisitPK userVisitPK, CreateCarrierOptionDescriptionForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var carrierControl = Session.getModelController(CarrierControl.class);
074        String carrierName = form.getCarrierName();
075        Carrier carrier = carrierControl.getCarrierByName(carrierName);
076        
077        if(carrier != null) {
078            Party carrierParty = carrier.getParty();
079            String carrierOptionName = form.getCarrierOptionName();
080            CarrierOption carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName);
081            
082            if(carrierOption != null) {
083                var partyControl = Session.getModelController(PartyControl.class);
084                String languageIsoName = form.getLanguageIsoName();
085                Language language = partyControl.getLanguageByIsoName(languageIsoName);
086                
087                if(language != null) {
088                    CarrierOptionDescription carrierOptionDescription = carrierControl.getCarrierOptionDescription(carrierOption, language);
089                    
090                    if(carrierOptionDescription == null) {
091                        var description = form.getDescription();
092                        
093                        carrierControl.createCarrierOptionDescription(carrierOption, language, description, getPartyPK());
094                    } else {
095                        addExecutionError(ExecutionErrors.DuplicateCarrierOptionDescription.name(), carrierName, carrierOptionName, languageIsoName);
096                    }
097                } else {
098                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
099                }
100            } else {
101                addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName);
102            }
103        } else {
104            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
105        }
106        
107        return null;
108    }
109    
110}