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.common;
018
019import com.echothree.control.user.wishlist.common.form.*;
020import com.echothree.control.user.wishlist.common.result.*;
021import com.echothree.model.data.user.common.pk.UserVisitPK;
022import com.echothree.util.common.command.CommandResult;
023import com.echothree.util.common.command.VoidResult;
024
025public interface WishlistService
026        extends WishlistForms {
027    
028    // -------------------------------------------------------------------------
029    //   Testing
030    // -------------------------------------------------------------------------
031    
032    String ping();
033    
034    // -------------------------------------------------------------------------
035    //   Wishlist Types
036    // -------------------------------------------------------------------------
037    
038    CommandResult<CreateWishlistTypeResult> createWishlistType(UserVisitPK userVisitPK, CreateWishlistTypeForm form);
039    
040    CommandResult<GetWishlistTypeResult> getWishlistType(UserVisitPK userVisitPK, GetWishlistTypeForm form);
041    
042    CommandResult<GetWishlistTypesResult> getWishlistTypes(UserVisitPK userVisitPK, GetWishlistTypesForm form);
043    
044    CommandResult<GetWishlistTypeChoicesResult> getWishlistTypeChoices(UserVisitPK userVisitPK, GetWishlistTypeChoicesForm form);
045    
046    CommandResult<VoidResult> setDefaultWishlistType(UserVisitPK userVisitPK, SetDefaultWishlistTypeForm form);
047    
048    CommandResult<EditWishlistTypeResult> editWishlistType(UserVisitPK userVisitPK, EditWishlistTypeForm form);
049    
050    CommandResult<VoidResult> deleteWishlistType(UserVisitPK userVisitPK, DeleteWishlistTypeForm form);
051    
052    // -------------------------------------------------------------------------
053    //   Wishlist Type Descriptions
054    // -------------------------------------------------------------------------
055    
056    CommandResult<VoidResult> createWishlistTypeDescription(UserVisitPK userVisitPK, CreateWishlistTypeDescriptionForm form);
057    
058    CommandResult<GetWishlistTypeDescriptionsResult> getWishlistTypeDescriptions(UserVisitPK userVisitPK, GetWishlistTypeDescriptionsForm form);
059    
060    CommandResult<EditWishlistTypeDescriptionResult> editWishlistTypeDescription(UserVisitPK userVisitPK, EditWishlistTypeDescriptionForm form);
061    
062    CommandResult<VoidResult> deleteWishlistTypeDescription(UserVisitPK userVisitPK, DeleteWishlistTypeDescriptionForm form);
063    
064    // -------------------------------------------------------------------------
065    //   Wishlist Type Priorities
066    // -------------------------------------------------------------------------
067    
068    CommandResult<CreateWishlistPriorityResult> createWishlistPriority(UserVisitPK userVisitPK, CreateWishlistPriorityForm form);
069    
070    CommandResult<GetWishlistPriorityResult> getWishlistPriority(UserVisitPK userVisitPK, GetWishlistPriorityForm form);
071    
072    CommandResult<GetWishlistPrioritiesResult> getWishlistPriorities(UserVisitPK userVisitPK, GetWishlistPrioritiesForm form);
073    
074    CommandResult<GetWishlistPriorityChoicesResult> getWishlistPriorityChoices(UserVisitPK userVisitPK, GetWishlistPriorityChoicesForm form);
075    
076    CommandResult<VoidResult> setDefaultWishlistPriority(UserVisitPK userVisitPK, SetDefaultWishlistPriorityForm form);
077    
078    CommandResult<EditWishlistPriorityResult> editWishlistPriority(UserVisitPK userVisitPK, EditWishlistPriorityForm form);
079    
080    CommandResult<VoidResult> deleteWishlistPriority(UserVisitPK userVisitPK, DeleteWishlistPriorityForm form);
081    
082    // -------------------------------------------------------------------------
083    //   Wishlist Type Priority Descriptions
084    // -------------------------------------------------------------------------
085    
086    CommandResult<VoidResult> createWishlistPriorityDescription(UserVisitPK userVisitPK, CreateWishlistPriorityDescriptionForm form);
087    
088    CommandResult<GetWishlistPriorityDescriptionsResult> getWishlistPriorityDescriptions(UserVisitPK userVisitPK, GetWishlistPriorityDescriptionsForm form);
089    
090    CommandResult<EditWishlistPriorityDescriptionResult> editWishlistPriorityDescription(UserVisitPK userVisitPK, EditWishlistPriorityDescriptionForm form);
091    
092    CommandResult<VoidResult> deleteWishlistPriorityDescription(UserVisitPK userVisitPK, DeleteWishlistPriorityDescriptionForm form);
093    
094    // -------------------------------------------------------------------------
095    //   Wishlist Lines
096    // -------------------------------------------------------------------------
097    
098    CommandResult<VoidResult> createWishlistLine(UserVisitPK userVisitPK, CreateWishlistLineForm form);
099    
100    CommandResult<GetWishlistLinesResult> getWishlistLines(UserVisitPK userVisitPK, GetWishlistLinesForm form);
101    
102}