001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.Arrays;
043import java.util.Collections;
044import java.util.List;
045import javax.enterprise.context.RequestScoped;
046
047@RequestScoped
048public class EditCarrierOptionDescriptionCommand
049        extends BaseAbstractEditCommand<CarrierOptionDescriptionSpec, CarrierOptionDescriptionEdit, EditCarrierOptionDescriptionResult, CarrierOptionDescription, CarrierOption> {
050
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
059                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierOption.name(), SecurityRoles.Description.name())
060                        )))
061                )));
062
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("CarrierOptionName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
067                ));
068
069        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
070                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
071                ));
072    }
073
074    /** Creates a new instance of EditCarrierOptionDescriptionCommand */
075    public EditCarrierOptionDescriptionCommand() {
076        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078
079    @Override
080    public EditCarrierOptionDescriptionResult getResult() {
081        return CarrierResultFactory.getEditCarrierOptionDescriptionResult();
082    }
083
084    @Override
085    public CarrierOptionDescriptionEdit getEdit() {
086        return CarrierEditFactory.getCarrierOptionDescriptionEdit();
087    }
088
089    @Override
090    public CarrierOptionDescription getEntity(EditCarrierOptionDescriptionResult result) {
091        var carrierControl = Session.getModelController(CarrierControl.class);
092        CarrierOptionDescription carrierOptionDescription = null;
093        var carrierName = spec.getCarrierName();
094        var carrier = carrierControl.getCarrierByName(carrierName);
095
096        if(carrier != null) {
097            var carrierParty = carrier.getParty();
098            var carrierOptionName = spec.getCarrierOptionName();
099            var carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName);
100
101            if(carrierOption != null) {
102                var partyControl = Session.getModelController(PartyControl.class);
103                var languageIsoName = spec.getLanguageIsoName();
104                var language = partyControl.getLanguageByIsoName(languageIsoName);
105
106                if(language != null) {
107                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
108                        carrierOptionDescription = carrierControl.getCarrierOptionDescription(carrierOption, language);
109                    } else { // EditMode.UPDATE
110                        carrierOptionDescription = carrierControl.getCarrierOptionDescriptionForUpdate(carrierOption, language);
111                    }
112
113                    if(carrierOptionDescription == null) {
114                        addExecutionError(ExecutionErrors.UnknownCarrierOptionDescription.name(), carrierOptionName, languageIsoName);
115                    }
116                } else {
117                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
118                }
119            } else {
120                addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName);
121            }
122        } else {
123            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
124        }
125
126        return carrierOptionDescription;
127    }
128
129    @Override
130    public CarrierOption getLockEntity(CarrierOptionDescription carrierOptionDescription) {
131        return carrierOptionDescription.getCarrierOption();
132    }
133
134    @Override
135    public void fillInResult(EditCarrierOptionDescriptionResult result, CarrierOptionDescription carrierOptionDescription) {
136        var carrierControl = Session.getModelController(CarrierControl.class);
137
138        result.setCarrierOptionDescription(carrierControl.getCarrierOptionDescriptionTransfer(getUserVisit(), carrierOptionDescription));
139    }
140
141    @Override
142    public void doLock(CarrierOptionDescriptionEdit edit, CarrierOptionDescription carrierOptionDescription) {
143        edit.setDescription(carrierOptionDescription.getDescription());
144    }
145
146    @Override
147    public void doUpdate(CarrierOptionDescription carrierOptionDescription) {
148        var carrierControl = Session.getModelController(CarrierControl.class);
149        var carrierOptionDescriptionValue = carrierControl.getCarrierOptionDescriptionValue(carrierOptionDescription);
150
151        carrierOptionDescriptionValue.setDescription(edit.getDescription());
152
153        carrierControl.updateCarrierOptionDescriptionFromValue(carrierOptionDescriptionValue, getPartyPK());
154    }
155
156}