001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.wishlist.server.command;
018
019import com.echothree.control.user.wishlist.common.edit.WishlistEditFactory;
020import com.echothree.control.user.wishlist.common.edit.WishlistPriorityDescriptionEdit;
021import com.echothree.control.user.wishlist.common.form.EditWishlistPriorityDescriptionForm;
022import com.echothree.control.user.wishlist.common.result.EditWishlistPriorityDescriptionResult;
023import com.echothree.control.user.wishlist.common.result.WishlistResultFactory;
024import com.echothree.control.user.wishlist.common.spec.WishlistPriorityDescriptionSpec;
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.control.wishlist.server.control.WishlistControl;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.model.data.wishlist.server.entity.WishlistType;
033import com.echothree.model.data.wishlist.server.entity.WishlistPriority;
034import com.echothree.model.data.wishlist.server.entity.WishlistPriorityDescription;
035import com.echothree.model.data.wishlist.server.value.WishlistPriorityDescriptionValue;
036import com.echothree.util.common.message.ExecutionErrors;
037import com.echothree.util.common.validation.FieldDefinition;
038import com.echothree.util.common.validation.FieldType;
039import com.echothree.util.common.command.BaseResult;
040import com.echothree.util.common.command.EditMode;
041import com.echothree.util.server.control.BaseEditCommand;
042import com.echothree.util.server.control.CommandSecurityDefinition;
043import com.echothree.util.server.control.PartyTypeDefinition;
044import com.echothree.util.server.control.SecurityRoleDefinition;
045import com.echothree.util.server.persistence.Session;
046import java.util.Arrays;
047import java.util.Collections;
048import java.util.List;
049
050public class EditWishlistPriorityDescriptionCommand
051        extends BaseEditCommand<WishlistPriorityDescriptionSpec, WishlistPriorityDescriptionEdit> {
052
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056    
057    static {
058        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
061                        new SecurityRoleDefinition(SecurityRoleGroups.WishlistPriority.name(), SecurityRoles.Description.name())
062                )))
063        )));
064
065        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066            new FieldDefinition("WishlistTypeName", FieldType.ENTITY_NAME, true, null, null),
067            new FieldDefinition("WishlistPriorityName", FieldType.ENTITY_NAME, true, null, null),
068            new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
069        ));
070        
071        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
072            new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
073        ));
074    }
075    
076    /** Creates a new instance of EditWishlistPriorityDescriptionCommand */
077    public EditWishlistPriorityDescriptionCommand(UserVisitPK userVisitPK, EditWishlistPriorityDescriptionForm form) {
078        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    protected BaseResult execute() {
083        var wishlistControl = Session.getModelController(WishlistControl.class);
084        EditWishlistPriorityDescriptionResult result = WishlistResultFactory.getEditWishlistPriorityDescriptionResult();
085        String wishlistTypeName = spec.getWishlistTypeName();
086        WishlistType wishlistType = wishlistControl.getWishlistTypeByName(wishlistTypeName);
087        
088        if(wishlistType != null) {
089            String wishlistPriorityName = spec.getWishlistPriorityName();
090            WishlistPriority wishlistPriority = wishlistControl.getWishlistPriorityByName(wishlistType, wishlistPriorityName);
091            
092            if(wishlistPriority != null) {
093                var partyControl = Session.getModelController(PartyControl.class);
094                String languageIsoName = spec.getLanguageIsoName();
095                Language language = partyControl.getLanguageByIsoName(languageIsoName);
096                
097                if(language != null) {
098                    if(editMode.equals(EditMode.LOCK)) {
099                        WishlistPriorityDescription wishlistPriorityDescription = wishlistControl.getWishlistPriorityDescription(wishlistPriority, language);
100                        
101                        if(wishlistPriorityDescription != null) {
102                            result.setWishlistPriorityDescription(wishlistControl.getWishlistPriorityDescriptionTransfer(getUserVisit(), wishlistPriorityDescription));
103                            
104                            if(lockEntity(wishlistPriority)) {
105                                WishlistPriorityDescriptionEdit edit = WishlistEditFactory.getWishlistPriorityDescriptionEdit();
106                                
107                                result.setEdit(edit);
108                                edit.setDescription(wishlistPriorityDescription.getDescription());
109                            } else {
110                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
111                            }
112                            
113                            result.setEntityLock(getEntityLockTransfer(wishlistPriority));
114                        } else {
115                            addExecutionError(ExecutionErrors.UnknownWishlistPriorityDescription.name());
116                        }
117                    } else if(editMode.equals(EditMode.UPDATE)) {
118                        WishlistPriorityDescriptionValue wishlistPriorityDescriptionValue = wishlistControl.getWishlistPriorityDescriptionValueForUpdate(wishlistPriority, language);
119                        
120                        if(wishlistPriorityDescriptionValue != null) {
121                            if(lockEntityForUpdate(wishlistPriority)) {
122                                try {
123                                    String description = edit.getDescription();
124                                    
125                                    wishlistPriorityDescriptionValue.setDescription(description);
126                                    
127                                    wishlistControl.updateWishlistPriorityDescriptionFromValue(wishlistPriorityDescriptionValue, getPartyPK());
128                                } finally {
129                                    unlockEntity(wishlistPriority);
130                                }
131                            } else {
132                                addExecutionError(ExecutionErrors.EntityLockStale.name());
133                            }
134                        } else {
135                            addExecutionError(ExecutionErrors.UnknownWishlistPriorityDescription.name());
136                        }
137                    }
138                } else {
139                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
140                }
141            } else {
142                addExecutionError(ExecutionErrors.UnknownWishlistPriorityName.name(), wishlistPriorityName);
143            }
144        } else {
145            addExecutionError(ExecutionErrors.UnknownWishlistTypeName.name(), wishlistTypeName);
146        }
147        
148        return result;
149    }
150    
151}