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.form.EditSelectorDescriptionForm;
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.user.common.pk.UserVisitPK;
030import com.echothree.util.common.command.BaseResult;
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.BaseEditCommand;
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.List;
041import javax.enterprise.context.Dependent;
042
043@Dependent
044public class EditSelectorDescriptionCommand
045        extends BaseEditCommand<SelectorDescriptionSpec, SelectorDescriptionEdit> {
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    /** Creates a new instance of EditSelectorDescriptionCommand */
072    public EditSelectorDescriptionCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075    
076    @Override
077    protected BaseResult execute() {
078        var selectorControl = Session.getModelController(SelectorControl.class);
079        var result = SelectorResultFactory.getEditSelectorDescriptionResult();
080        var selectorKindName = spec.getSelectorKindName();
081        var selectorKind = selectorControl.getSelectorKindByName(selectorKindName);
082        
083        if(selectorKind != null) {
084            var selectorTypeName = spec.getSelectorTypeName();
085            var selectorType = selectorControl.getSelectorTypeByName(selectorKind, selectorTypeName);
086            
087            if(selectorType != null) {
088                var selectorName = spec.getSelectorName();
089                var selector = selectorControl.getSelectorByName(selectorType, selectorName);
090                
091                if(selector != null) {
092                    var partyControl = Session.getModelController(PartyControl.class);
093                    var languageIsoName = spec.getLanguageIsoName();
094                    var language = partyControl.getLanguageByIsoName(languageIsoName);
095                    
096                    if(language != null) {
097                        if(editMode.equals(EditMode.LOCK)) {
098                            var selectorDescription = selectorControl.getSelectorDescription(selector, language);
099                            
100                            if(selectorDescription != null) {
101                                result.setSelectorDescription(selectorControl.getSelectorDescriptionTransfer(getUserVisit(), selectorDescription));
102                                
103                                if(lockEntity(selector)) {
104                                    var edit = SelectorEditFactory.getSelectorDescriptionEdit();
105                                    
106                                    result.setEdit(edit);
107                                    edit.setDescription(selectorDescription.getDescription());
108                                } else {
109                                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
110                                }
111                                
112                                result.setEntityLock(getEntityLockTransfer(selector));
113                            } else {
114                                addExecutionError(ExecutionErrors.UnknownSelectorDescription.name());
115                            }
116                        } else if(editMode.equals(EditMode.UPDATE)) {
117                            var selectorDescriptionValue = selectorControl.getSelectorDescriptionValueForUpdate(selector, language);
118                            
119                            if(selectorDescriptionValue != null) {
120                                if(lockEntityForUpdate(selector)) {
121                                    try {
122                                        var description = edit.getDescription();
123                                        
124                                        selectorDescriptionValue.setDescription(description);
125                                        
126                                        selectorControl.updateSelectorDescriptionFromValue(selectorDescriptionValue, getPartyPK());
127                                    } finally {
128                                        unlockEntity(selector);
129                                    }
130                                } else {
131                                    addExecutionError(ExecutionErrors.EntityLockStale.name());
132                                }
133                            } else {
134                                addExecutionError(ExecutionErrors.UnknownSelectorDescription.name());
135                            }
136                        }
137                    } else {
138                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
139                    }
140                } else {
141                    addExecutionError(ExecutionErrors.UnknownSelectorName.name(), selectorName);
142                }
143            } else {
144                addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), selectorTypeName);
145            }
146        } else {
147            addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), selectorKindName);
148        }
149        
150        return result;
151    }
152    
153}