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.UseDescriptionEdit;
021import com.echothree.control.user.offer.common.form.EditUseDescriptionForm;
022import com.echothree.control.user.offer.common.result.OfferResultFactory;
023import com.echothree.control.user.offer.common.spec.UseDescriptionSpec;
024import com.echothree.model.control.offer.server.control.UseControl;
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 java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditUseDescriptionCommand
045        extends BaseEditCommand<UseDescriptionSpec, UseDescriptionEdit> {
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.Use.name(), SecurityRoles.Description.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("UseName", 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    @Inject
070    PartyControl partyControl;
071
072    @Inject
073    UseControl useControl;
074
075    
076    /** Creates a new instance of EditUseDescriptionCommand */
077    public EditUseDescriptionCommand() {
078        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    protected BaseResult execute() {
083        var result = OfferResultFactory.getEditUseDescriptionResult();
084        var useName = spec.getUseName();
085        var use = useControl.getUseByName(useName);
086        
087        if(use != null) {
088            var languageIsoName = spec.getLanguageIsoName();
089            var language = partyControl.getLanguageByIsoName(languageIsoName);
090            
091            if(language != null) {
092                if(editMode.equals(EditMode.LOCK)) {
093                    var useDescription = useControl.getUseDescription(use, language);
094                    
095                    if(useDescription != null) {
096                        result.setUseDescription(useControl.getUseDescriptionTransfer(getUserVisit(), useDescription));
097                        
098                        if(lockEntity(use)) {
099                            var edit = OfferEditFactory.getUseDescriptionEdit();
100                            
101                            result.setEdit(edit);
102                            edit.setDescription(useDescription.getDescription());
103                        } else {
104                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
105                        }
106                        
107                        result.setEntityLock(getEntityLockTransfer(use));
108                    } else {
109                        addExecutionError(ExecutionErrors.UnknownUseDescription.name());
110                    }
111                } else if(editMode.equals(EditMode.UPDATE)) {
112                    var useDescriptionValue = useControl.getUseDescriptionValueForUpdate(use, language);
113                    
114                    if(useDescriptionValue != null) {
115                        if(lockEntityForUpdate(use)) {
116                            try {
117                                var description = edit.getDescription();
118                                
119                                useDescriptionValue.setDescription(description);
120                                
121                                useControl.updateUseDescriptionFromValue(useDescriptionValue, getPartyPK());
122                            } finally {
123                                unlockEntity(use);
124                            }
125                        } else {
126                            addExecutionError(ExecutionErrors.EntityLockStale.name());
127                        }
128                    } else {
129                        addExecutionError(ExecutionErrors.UnknownUseDescription.name());
130                    }
131                }
132            } else {
133                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
134            }
135        } else {
136            addExecutionError(ExecutionErrors.UnknownUseName.name(), useName);
137        }
138        
139        return result;
140    }
141    
142}