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.wishlist.server.command;
018
019import com.echothree.control.user.wishlist.common.form.GetWishlistPrioritiesForm;
020import com.echothree.control.user.wishlist.common.result.WishlistResultFactory;
021import com.echothree.model.control.wishlist.server.control.WishlistControl;
022import com.echothree.model.control.wishlist.server.logic.WishlistTypeLogic;
023import com.echothree.model.data.wishlist.server.entity.WishlistPriority;
024import com.echothree.model.data.wishlist.server.entity.WishlistType;
025import com.echothree.model.data.wishlist.server.factory.WishlistPriorityFactory;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
030import java.util.Collection;
031import java.util.List;
032import javax.enterprise.context.Dependent;
033import javax.inject.Inject;
034
035@Dependent
036public class GetWishlistPrioritiesCommand
037        extends BasePaginatedMultipleEntitiesCommand<WishlistPriority, GetWishlistPrioritiesForm> {
038
039    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041
042    static {
043        FORM_FIELD_DEFINITIONS = List.of(
044                new FieldDefinition("WishlistTypeName", FieldType.ENTITY_NAME, true, null, null)
045        );
046    }
047
048    @Inject
049    WishlistControl wishlistControl;
050
051    @Inject
052    WishlistTypeLogic wishlistTypeLogic;
053
054    /** Creates a new instance of GetWishlistPrioritiesCommand */
055    public GetWishlistPrioritiesCommand() {
056        super(null, FORM_FIELD_DEFINITIONS, true);
057    }
058
059    WishlistType wishlistType;
060
061    @Override
062    protected void handleForm() {
063        var wishlistTypeName = form.getWishlistTypeName();
064
065        wishlistType = wishlistTypeLogic.getWishlistTypeByName(this, wishlistTypeName);
066    }
067
068    @Override
069    protected Long getTotalEntities() {
070        return hasExecutionErrors() ? null :
071                wishlistControl.countWishlistPrioritiesByWishlistType(wishlistType);
072    }
073
074    @Override
075    protected Collection<WishlistPriority> getEntities() {
076        Collection<WishlistPriority> wishlistPriorities = null;
077
078        if(!hasExecutionErrors()) {
079            wishlistPriorities = wishlistControl.getWishlistPriorities(wishlistType);
080        }
081
082        return wishlistPriorities;
083    }
084
085    @Override
086    protected BaseResult getResult(Collection<WishlistPriority> entities) {
087        var result = WishlistResultFactory.getGetWishlistPrioritiesResult();
088
089        if(entities != null) {
090            var userVisit = getUserVisit();
091
092            if(session.hasLimit(WishlistPriorityFactory.class)) {
093                result.setWishlistPriorityCount(wishlistControl.countWishlistPrioritiesByWishlistType(wishlistType));
094            }
095
096            result.setWishlistType(wishlistControl.getWishlistTypeTransfer(userVisit, wishlistType));
097            result.setWishlistPriorities(wishlistControl.getWishlistPriorityTransfers(userVisit, entities));
098        }
099
100        return result;
101    }
102}