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.edit.CarrierEditFactory;
020import com.echothree.control.user.carrier.common.edit.CarrierServiceDescriptionEdit;
021import com.echothree.control.user.carrier.common.form.EditCarrierServiceDescriptionForm;
022import com.echothree.control.user.carrier.common.result.CarrierResultFactory;
023import com.echothree.control.user.carrier.common.result.EditCarrierServiceDescriptionResult;
024import com.echothree.control.user.carrier.common.spec.CarrierServiceDescriptionSpec;
025import com.echothree.model.control.carrier.server.control.CarrierControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.carrier.server.entity.CarrierService;
031import com.echothree.model.data.carrier.server.entity.CarrierServiceDescription;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class EditCarrierServiceDescriptionCommand
047        extends BaseAbstractEditCommand<CarrierServiceDescriptionSpec, CarrierServiceDescriptionEdit, EditCarrierServiceDescriptionResult, CarrierServiceDescription, CarrierService> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierService.name(), SecurityRoles.Description.name())
058                ))
059        ));
060
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("CarrierServiceName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
065        );
066        
067        EDIT_FIELD_DEFINITIONS = List.of(
068                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
069        );
070    }
071
072    @Inject
073    CarrierControl carrierControl;
074
075    @Inject
076    PartyControl partyControl;
077
078    
079    /** Creates a new instance of EditCarrierServiceDescriptionCommand */
080    public EditCarrierServiceDescriptionCommand() {
081        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
082    }
083    
084    @Override
085    public EditCarrierServiceDescriptionResult getResult() {
086        return CarrierResultFactory.getEditCarrierServiceDescriptionResult();
087    }
088
089    @Override
090    public CarrierServiceDescriptionEdit getEdit() {
091        return CarrierEditFactory.getCarrierServiceDescriptionEdit();
092    }
093
094    @Override
095    public CarrierServiceDescription getEntity(EditCarrierServiceDescriptionResult result) {
096        CarrierServiceDescription carrierServiceDescription = null;
097        var carrierName = spec.getCarrierName();
098        var carrier = carrierControl.getCarrierByName(carrierName);
099
100        if(carrier != null) {
101            var carrierParty = carrier.getParty();
102            var carrierServiceName = spec.getCarrierServiceName();
103            var carrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
104
105            if(carrierService != null) {
106                var languageIsoName = spec.getLanguageIsoName();
107                var language = partyControl.getLanguageByIsoName(languageIsoName);
108
109                if(language != null) {
110                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
111                        carrierServiceDescription = carrierControl.getCarrierServiceDescription(carrierService, language);
112                    } else { // EditMode.UPDATE
113                        carrierServiceDescription = carrierControl.getCarrierServiceDescriptionForUpdate(carrierService, language);
114                    }
115
116                    if(carrierServiceDescription == null) {
117                        addExecutionError(ExecutionErrors.UnknownCarrierServiceDescription.name(), carrierServiceName, languageIsoName);
118                    }
119                } else {
120                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
121                }
122            } else {
123                addExecutionError(ExecutionErrors.UnknownCarrierServiceName.name(), carrierName, carrierServiceName);
124            }
125        } else {
126            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
127        }
128
129        return carrierServiceDescription;
130    }
131
132    @Override
133    public CarrierService getLockEntity(CarrierServiceDescription carrierServiceDescription) {
134        return carrierServiceDescription.getCarrierService();
135    }
136
137    @Override
138    public void fillInResult(EditCarrierServiceDescriptionResult result, CarrierServiceDescription carrierServiceDescription) {
139        result.setCarrierServiceDescription(carrierControl.getCarrierServiceDescriptionTransfer(getUserVisit(), carrierServiceDescription));
140    }
141
142    @Override
143    public void doLock(CarrierServiceDescriptionEdit edit, CarrierServiceDescription carrierServiceDescription) {
144        edit.setDescription(carrierServiceDescription.getDescription());
145    }
146
147    @Override
148    public void doUpdate(CarrierServiceDescription carrierServiceDescription) {
149        var carrierServiceDescriptionValue = carrierControl.getCarrierServiceDescriptionValue(carrierServiceDescription);
150
151        carrierServiceDescriptionValue.setDescription(edit.getDescription());
152
153        carrierControl.updateCarrierServiceDescriptionFromValue(carrierServiceDescriptionValue, getPartyPK());
154    }
155
156}