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.wishlist.server.command;
018
019import com.echothree.control.user.wishlist.common.form.GetWishlistPriorityDescriptionsForm;
020import com.echothree.control.user.wishlist.common.result.WishlistResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.wishlist.server.control.WishlistControl;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class GetWishlistPriorityDescriptionsCommand
042        extends BaseSimpleCommand<GetWishlistPriorityDescriptionsForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.WishlistPriority.name(), SecurityRoles.Description.name())
052                )))
053        )));
054
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056            new FieldDefinition("WishlistTypeName", FieldType.ENTITY_NAME, true, null, null),
057            new FieldDefinition("WishlistPriorityName", FieldType.ENTITY_NAME, true, null, null)
058        ));
059    }
060    
061    /** Creates a new instance of GetWishlistPriorityDescriptionsCommand */
062    public GetWishlistPriorityDescriptionsCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var wishlistControl = Session.getModelController(WishlistControl.class);
069        var result = WishlistResultFactory.getGetWishlistPriorityDescriptionsResult();
070        var wishlistTypeName = form.getWishlistTypeName();
071        var wishlistType = wishlistControl.getWishlistTypeByName(wishlistTypeName);
072        
073        if(wishlistType != null) {
074            var wishlistPriorityName = form.getWishlistPriorityName();
075            var wishlistPriority = wishlistControl.getWishlistPriorityByName(wishlistType, wishlistPriorityName);
076            
077            if(wishlistPriority != null) {
078                result.setWishlistPriority(wishlistControl.getWishlistPriorityTransfer(getUserVisit(), wishlistPriority));
079                result.setWishlistPriorityDescriptions(wishlistControl.getWishlistPriorityDescriptionTransfers(getUserVisit(), wishlistPriority));
080            } else {
081                addExecutionError(ExecutionErrors.UnknownWishlistPriorityName.name(), wishlistPriorityName);
082            }
083        } else {
084            addExecutionError(ExecutionErrors.UnknownWishlistTypeName.name(), wishlistTypeName);
085        }
086        
087        return result;
088    }
089    
090}