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.form.GetWishlistPriorityChoicesForm;
020import com.echothree.control.user.wishlist.common.result.GetWishlistPriorityChoicesResult;
021import com.echothree.control.user.wishlist.common.result.WishlistResultFactory;
022import com.echothree.model.control.wishlist.server.control.WishlistControl;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.model.data.wishlist.server.entity.WishlistType;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.persistence.Session;
031import java.util.Arrays;
032import java.util.Collections;
033import java.util.List;
034
035public class GetWishlistPriorityChoicesCommand
036        extends BaseSimpleCommand<GetWishlistPriorityChoicesForm> {
037
038    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
043            new FieldDefinition("WishlistTypeName", FieldType.ENTITY_NAME, true, null, null),
044            new FieldDefinition("DefaultWishlistPriorityChoice", FieldType.ENTITY_NAME, false, null, null),
045            new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
046        ));
047    }
048    
049    /** Creates a new instance of GetWishlistPriorityChoicesCommand */
050    public GetWishlistPriorityChoicesCommand(UserVisitPK userVisitPK, GetWishlistPriorityChoicesForm form) {
051        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
052    }
053    
054    @Override
055    protected BaseResult execute() {
056        var wishlistControl = Session.getModelController(WishlistControl.class);
057        GetWishlistPriorityChoicesResult result = WishlistResultFactory.getGetWishlistPriorityChoicesResult();
058        String wishlistTypeName = form.getWishlistTypeName();
059        WishlistType wishlistType = wishlistControl.getWishlistTypeByName(wishlistTypeName);
060        
061        if(wishlistType != null) {
062            String defaultWishlistPriorityChoice = form.getDefaultWishlistPriorityChoice();
063            boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
064            
065            result.setWishlistPriorityChoices(wishlistControl.getWishlistPriorityChoices(defaultWishlistPriorityChoice,
066                    getPreferredLanguage(), allowNullChoice, wishlistType));
067        } else {
068            addExecutionError(ExecutionErrors.UnknownWishlistTypeName.name(), wishlistTypeName);
069        }
070        
071        return result;
072    }
073    
074}