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.CarrierOptionDescriptionEdit;
021import com.echothree.control.user.carrier.common.form.EditCarrierOptionDescriptionForm;
022import com.echothree.control.user.carrier.common.result.CarrierResultFactory;
023import com.echothree.control.user.carrier.common.result.EditCarrierOptionDescriptionResult;
024import com.echothree.control.user.carrier.common.spec.CarrierOptionDescriptionSpec;
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.CarrierOption;
031import com.echothree.model.data.carrier.server.entity.CarrierOptionDescription;
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 com.echothree.util.server.persistence.Session;
042import java.util.List;
043import javax.enterprise.context.Dependent;
044
045@Dependent
046public class EditCarrierOptionDescriptionCommand
047        extends BaseAbstractEditCommand<CarrierOptionDescriptionSpec, CarrierOptionDescriptionEdit, EditCarrierOptionDescriptionResult, CarrierOptionDescription, CarrierOption> {
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.CarrierOption.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("CarrierOptionName", 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    /** Creates a new instance of EditCarrierOptionDescriptionCommand */
073    public EditCarrierOptionDescriptionCommand() {
074        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
075    }
076
077    @Override
078    public EditCarrierOptionDescriptionResult getResult() {
079        return CarrierResultFactory.getEditCarrierOptionDescriptionResult();
080    }
081
082    @Override
083    public CarrierOptionDescriptionEdit getEdit() {
084        return CarrierEditFactory.getCarrierOptionDescriptionEdit();
085    }
086
087    @Override
088    public CarrierOptionDescription getEntity(EditCarrierOptionDescriptionResult result) {
089        var carrierControl = Session.getModelController(CarrierControl.class);
090        CarrierOptionDescription carrierOptionDescription = null;
091        var carrierName = spec.getCarrierName();
092        var carrier = carrierControl.getCarrierByName(carrierName);
093
094        if(carrier != null) {
095            var carrierParty = carrier.getParty();
096            var carrierOptionName = spec.getCarrierOptionName();
097            var carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName);
098
099            if(carrierOption != null) {
100                var partyControl = Session.getModelController(PartyControl.class);
101                var languageIsoName = spec.getLanguageIsoName();
102                var language = partyControl.getLanguageByIsoName(languageIsoName);
103
104                if(language != null) {
105                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
106                        carrierOptionDescription = carrierControl.getCarrierOptionDescription(carrierOption, language);
107                    } else { // EditMode.UPDATE
108                        carrierOptionDescription = carrierControl.getCarrierOptionDescriptionForUpdate(carrierOption, language);
109                    }
110
111                    if(carrierOptionDescription == null) {
112                        addExecutionError(ExecutionErrors.UnknownCarrierOptionDescription.name(), carrierOptionName, languageIsoName);
113                    }
114                } else {
115                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
116                }
117            } else {
118                addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName);
119            }
120        } else {
121            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
122        }
123
124        return carrierOptionDescription;
125    }
126
127    @Override
128    public CarrierOption getLockEntity(CarrierOptionDescription carrierOptionDescription) {
129        return carrierOptionDescription.getCarrierOption();
130    }
131
132    @Override
133    public void fillInResult(EditCarrierOptionDescriptionResult result, CarrierOptionDescription carrierOptionDescription) {
134        var carrierControl = Session.getModelController(CarrierControl.class);
135
136        result.setCarrierOptionDescription(carrierControl.getCarrierOptionDescriptionTransfer(getUserVisit(), carrierOptionDescription));
137    }
138
139    @Override
140    public void doLock(CarrierOptionDescriptionEdit edit, CarrierOptionDescription carrierOptionDescription) {
141        edit.setDescription(carrierOptionDescription.getDescription());
142    }
143
144    @Override
145    public void doUpdate(CarrierOptionDescription carrierOptionDescription) {
146        var carrierControl = Session.getModelController(CarrierControl.class);
147        var carrierOptionDescriptionValue = carrierControl.getCarrierOptionDescriptionValue(carrierOptionDescription);
148
149        carrierOptionDescriptionValue.setDescription(edit.getDescription());
150
151        carrierControl.updateCarrierOptionDescriptionFromValue(carrierOptionDescriptionValue, getPartyPK());
152    }
153
154}