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.selector.server.command;
018
019import com.echothree.control.user.selector.common.edit.SelectorDescriptionEdit;
020import com.echothree.control.user.selector.common.edit.SelectorEditFactory;
021import com.echothree.control.user.selector.common.result.EditSelectorDescriptionResult;
022import com.echothree.control.user.selector.common.result.SelectorResultFactory;
023import com.echothree.control.user.selector.common.spec.SelectorDescriptionSpec;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.party.server.control.PartyControl;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.selector.server.control.SelectorControl;
029import com.echothree.model.data.selector.server.entity.Selector;
030import com.echothree.model.data.selector.server.entity.SelectorDescription;
031import com.echothree.util.common.command.EditMode;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditSelectorDescriptionCommand
045        extends BaseAbstractEditCommand<SelectorDescriptionSpec, SelectorDescriptionEdit, EditSelectorDescriptionResult, SelectorDescription, Selector> {
046
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.Selector.name(), SecurityRoles.Description.name())
056                ))
057        ));
058
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("SelectorKindName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("SelectorTypeName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("SelectorName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
064        );
065        
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
068        );
069    }
070
071    @Inject
072    PartyControl partyControl;
073
074    @Inject
075    SelectorControl selectorControl;
076
077
078    /** Creates a new instance of EditSelectorDescriptionCommand */
079    public EditSelectorDescriptionCommand() {
080        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
081    }
082
083    @Override
084    public EditSelectorDescriptionResult getResult() {
085        return SelectorResultFactory.getEditSelectorDescriptionResult();
086    }
087
088    @Override
089    public SelectorDescriptionEdit getEdit() {
090        return SelectorEditFactory.getSelectorDescriptionEdit();
091    }
092
093    @Override
094    public SelectorDescription getEntity(EditSelectorDescriptionResult result) {
095        SelectorDescription selectorDescription = null;
096        var selectorKindName = spec.getSelectorKindName();
097        var selectorKind = selectorControl.getSelectorKindByName(selectorKindName);
098
099        if(selectorKind != null) {
100            var selectorTypeName = spec.getSelectorTypeName();
101            var selectorType = selectorControl.getSelectorTypeByName(selectorKind, selectorTypeName);
102
103            if(selectorType != null) {
104                var selectorName = spec.getSelectorName();
105                var selector = selectorControl.getSelectorByName(selectorType, selectorName);
106
107                if(selector != null) {
108                    var languageIsoName = spec.getLanguageIsoName();
109                    var language = partyControl.getLanguageByIsoName(languageIsoName);
110
111                    if(language != null) {
112                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
113                            selectorDescription = selectorControl.getSelectorDescription(selector, language);
114                        } else { // EditMode.UPDATE
115                            selectorDescription = selectorControl.getSelectorDescriptionForUpdate(selector, language);
116                        }
117
118                        if(selectorDescription == null) {
119                            addExecutionError(ExecutionErrors.UnknownSelectorDescription.name(), selectorKindName, selectorTypeName, selectorName, languageIsoName);
120                        }
121                    } else {
122                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
123                    }
124                } else {
125                    addExecutionError(ExecutionErrors.UnknownSelectorName.name(), selectorName);
126                }
127            } else {
128                addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), selectorTypeName);
129            }
130        } else {
131            addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), selectorKindName);
132        }
133
134        return selectorDescription;
135    }
136
137    @Override
138    public Selector getLockEntity(SelectorDescription selectorDescription) {
139        return selectorDescription.getSelector();
140    }
141
142    @Override
143    public void fillInResult(EditSelectorDescriptionResult result, SelectorDescription selectorDescription) {
144        result.setSelectorDescription(selectorControl.getSelectorDescriptionTransfer(getUserVisit(), selectorDescription));
145    }
146
147    @Override
148    public void doLock(SelectorDescriptionEdit edit, SelectorDescription selectorDescription) {
149        edit.setDescription(selectorDescription.getDescription());
150    }
151
152    @Override
153    public void doUpdate(SelectorDescription selectorDescription) {
154        var selectorDescriptionValue = selectorControl.getSelectorDescriptionValue(selectorDescription);
155
156        selectorDescriptionValue.setDescription(edit.getDescription());
157
158        selectorControl.updateSelectorDescriptionFromValue(selectorDescriptionValue, getPartyPK());
159    }
160
161}