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.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.user.common.pk.UserVisitPK;
024import com.echothree.model.data.wishlist.server.entity.WishlistType;
025import com.echothree.model.data.wishlist.server.entity.WishlistPriority;
026import com.echothree.model.data.wishlist.server.factory.WishlistPriorityFactory;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
031import com.echothree.util.server.persistence.Session;
032import java.util.Arrays;
033import java.util.Collection;
034import java.util.Collections;
035import java.util.List;
036
037public class GetWishlistPrioritiesCommand
038        extends BaseMultipleEntitiesCommand<WishlistPriority, GetWishlistPrioritiesForm> {
039
040    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
045            new FieldDefinition("WishlistTypeName", FieldType.ENTITY_NAME, true, null, null)
046        ));
047    }
048    
049    /** Creates a new instance of GetWishlistPrioritiesCommand */
050    public GetWishlistPrioritiesCommand(UserVisitPK userVisitPK, GetWishlistPrioritiesForm form) {
051        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
052    }
053
054    WishlistType wishlistType;
055
056    @Override
057    protected Collection<WishlistPriority> getEntities() {
058        var wishlistControl = Session.getModelController(WishlistControl.class);
059
060        wishlistType = WishlistTypeLogic.getInstance().getWishlistTypeByName(this, form.getWishlistTypeName());
061
062        return hasExecutionErrors() ? null : wishlistControl.getWishlistPriorities(wishlistType);
063    }
064
065    @Override
066    protected BaseResult getResult(Collection<WishlistPriority> entities) {
067        var result = WishlistResultFactory.getGetWishlistPrioritiesResult();
068
069        if(entities != null) {
070            var wishlistControl = Session.getModelController(WishlistControl.class);
071
072            if(session.hasLimit(WishlistPriorityFactory.class)) {
073                result.setWishlistPriorityCount(wishlistControl.countWishlistPrioritiesByWishlistType(wishlistType));
074            }
075
076            result.setWishlistType(wishlistControl.getWishlistTypeTransfer(getUserVisit(), wishlistType));
077            result.setWishlistPriorities(wishlistControl.getWishlistPriorityTransfers(getUserVisit(), entities));
078        }
079
080        return result;
081    }
082    
083}