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.offer.server.command;
018
019import com.echothree.control.user.offer.common.edit.OfferEditFactory;
020import com.echothree.control.user.offer.common.edit.UseNameElementDescriptionEdit;
021import com.echothree.control.user.offer.common.form.EditUseNameElementDescriptionForm;
022import com.echothree.control.user.offer.common.result.OfferResultFactory;
023import com.echothree.control.user.offer.common.spec.UseNameElementDescriptionSpec;
024import com.echothree.model.control.offer.server.control.UseNameElementControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.common.command.EditMode;
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 EditUseNameElementDescriptionCommand
045        extends BaseEditCommand<UseNameElementDescriptionSpec, UseNameElementDescriptionEdit> {
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.UseNameElement.name(), SecurityRoles.Description.name())
056                        ))
057                ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("UseNameElementName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062                );
063        
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
066                );
067    }
068    
069    /** Creates a new instance of EditUseNameElementDescriptionCommand */
070    public EditUseNameElementDescriptionCommand() {
071        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
077        var result = OfferResultFactory.getEditUseNameElementDescriptionResult();
078        var useNameElementName = spec.getUseNameElementName();
079        var useNameElement = useNameElementControl.getUseNameElementByName(useNameElementName);
080        
081        if(useNameElement != null) {
082            var partyControl = Session.getModelController(PartyControl.class);
083            var languageIsoName = spec.getLanguageIsoName();
084            var language = partyControl.getLanguageByIsoName(languageIsoName);
085            
086            if(language != null) {
087                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
088                    var useNameElementDescription = useNameElementControl.getUseNameElementDescription(useNameElement, language);
089                    
090                    if(useNameElementDescription != null) {
091                        if(editMode.equals(EditMode.LOCK)) {
092                            result.setUseNameElementDescription(useNameElementControl.getUseNameElementDescriptionTransfer(getUserVisit(), useNameElementDescription));
093
094                            if(lockEntity(useNameElement)) {
095                                var edit = OfferEditFactory.getUseNameElementDescriptionEdit();
096
097                                result.setEdit(edit);
098                                edit.setDescription(useNameElementDescription.getDescription());
099                            } else {
100                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
101                            }
102
103                            result.setEntityLock(getEntityLockTransfer(useNameElement));
104                        } else { // EditMode.ABANDON
105                            unlockEntity(useNameElement);
106                        }
107                    } else {
108                        addExecutionError(ExecutionErrors.UnknownUseNameElementDescription.name());
109                    }
110                } else if(editMode.equals(EditMode.UPDATE)) {
111                    var useNameElementDescriptionValue = useNameElementControl.getUseNameElementDescriptionValueForUpdate(useNameElement, language);
112                    
113                    if(useNameElementDescriptionValue != null) {
114                        if(lockEntityForUpdate(useNameElement)) {
115                            try {
116                                var description = edit.getDescription();
117                                
118                                useNameElementDescriptionValue.setDescription(description);
119                                
120                                useNameElementControl.updateUseNameElementDescriptionFromValue(useNameElementDescriptionValue, getPartyPK());
121                            } finally {
122                                unlockEntity(useNameElement);
123                            }
124                        } else {
125                            addExecutionError(ExecutionErrors.EntityLockStale.name());
126                        }
127                    } else {
128                        addExecutionError(ExecutionErrors.UnknownUseNameElementDescription.name());
129                    }
130                }
131            } else {
132                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
133            }
134        } else {
135            addExecutionError(ExecutionErrors.UnknownUseNameElementName.name(), useNameElementName);
136        }
137        
138        return result;
139    }
140    
141}