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.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 com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043import javax.enterprise.context.RequestScoped;
044
045@RequestScoped
046public class EditUseDescriptionCommand
047        extends BaseEditCommand<UseDescriptionSpec, UseDescriptionEdit> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
057                        new SecurityRoleDefinition(SecurityRoleGroups.Use.name(), SecurityRoles.Description.name())
058                        )))
059                )));
060        
061        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("UseName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
064                ));
065        
066        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
067                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
068                ));
069    }
070    
071    /** Creates a new instance of EditUseDescriptionCommand */
072    public EditUseDescriptionCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075    
076    @Override
077    protected BaseResult execute() {
078        var useControl = Session.getModelController(UseControl.class);
079        var result = OfferResultFactory.getEditUseDescriptionResult();
080        var useName = spec.getUseName();
081        var use = useControl.getUseByName(useName);
082        
083        if(use != null) {
084            var partyControl = Session.getModelController(PartyControl.class);
085            var languageIsoName = spec.getLanguageIsoName();
086            var language = partyControl.getLanguageByIsoName(languageIsoName);
087            
088            if(language != null) {
089                if(editMode.equals(EditMode.LOCK)) {
090                    var useDescription = useControl.getUseDescription(use, language);
091                    
092                    if(useDescription != null) {
093                        result.setUseDescription(useControl.getUseDescriptionTransfer(getUserVisit(), useDescription));
094                        
095                        if(lockEntity(use)) {
096                            var edit = OfferEditFactory.getUseDescriptionEdit();
097                            
098                            result.setEdit(edit);
099                            edit.setDescription(useDescription.getDescription());
100                        } else {
101                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
102                        }
103                        
104                        result.setEntityLock(getEntityLockTransfer(use));
105                    } else {
106                        addExecutionError(ExecutionErrors.UnknownUseDescription.name());
107                    }
108                } else if(editMode.equals(EditMode.UPDATE)) {
109                    var useDescriptionValue = useControl.getUseDescriptionValueForUpdate(use, language);
110                    
111                    if(useDescriptionValue != null) {
112                        if(lockEntityForUpdate(use)) {
113                            try {
114                                var description = edit.getDescription();
115                                
116                                useDescriptionValue.setDescription(description);
117                                
118                                useControl.updateUseDescriptionFromValue(useDescriptionValue, getPartyPK());
119                            } finally {
120                                unlockEntity(use);
121                            }
122                        } else {
123                            addExecutionError(ExecutionErrors.EntityLockStale.name());
124                        }
125                    } else {
126                        addExecutionError(ExecutionErrors.UnknownUseDescription.name());
127                    }
128                }
129            } else {
130                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
131            }
132        } else {
133            addExecutionError(ExecutionErrors.UnknownUseName.name(), useName);
134        }
135        
136        return result;
137    }
138    
139}