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.GetWishlistPriorityForm;
020import com.echothree.control.user.wishlist.common.result.WishlistResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.wishlist.server.control.WishlistControl;
023import com.echothree.model.control.wishlist.server.logic.WishlistPriorityLogic;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.model.data.wishlist.server.entity.WishlistPriority;
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.BaseSingleEntityCommand;
030import com.echothree.util.server.persistence.Session;
031import java.util.Arrays;
032import java.util.Collections;
033import java.util.List;
034import javax.enterprise.context.RequestScoped;
035
036@RequestScoped
037public class GetWishlistPriorityCommand
038        extends BaseSingleEntityCommand<WishlistPriority, GetWishlistPriorityForm> {
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, false, null, null),
046            new FieldDefinition("WishlistPriorityName", FieldType.ENTITY_NAME, false, null, null),
047            new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
048            new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
049        ));
050    }
051    
052    /** Creates a new instance of GetWishlistPriorityCommand */
053    public GetWishlistPriorityCommand() {
054        super(null, FORM_FIELD_DEFINITIONS, true);
055    }
056
057    @Override
058    protected WishlistPriority getEntity() {
059        var wishlistPriority = WishlistPriorityLogic.getInstance().getWishlistPriorityByUniversalSpec(this, form, true);
060
061        if(wishlistPriority != null) {
062            sendEvent(wishlistPriority.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
063        }
064
065        return wishlistPriority;
066    }
067
068    @Override
069    protected BaseResult getResult(WishlistPriority wishlistPriority) {
070        var wishlistControl = Session.getModelController(WishlistControl.class);
071        var result = WishlistResultFactory.getGetWishlistPriorityResult();
072
073        if(wishlistPriority != null) {
074            result.setWishlistPriority(wishlistControl.getWishlistPriorityTransfer(getUserVisit(), wishlistPriority));
075        }
076
077        return result;
078    }
079
080}