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.club.common;
018
019import com.echothree.control.user.club.common.form.*;
020import com.echothree.control.user.club.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 ClubService
026        extends ClubForms {
027    
028    // -------------------------------------------------------------------------
029    //   Testing
030    // -------------------------------------------------------------------------
031    
032    String ping();
033    
034    // --------------------------------------------------------------------------------
035    //   Clubs
036    // --------------------------------------------------------------------------------
037    
038    CommandResult<VoidResult> createClub(UserVisitPK userVisitPK, CreateClubForm form);
039    
040    CommandResult<GetClubsResult> getClubs(UserVisitPK userVisitPK, GetClubsForm form);
041    
042    CommandResult<GetClubResult> getClub(UserVisitPK userVisitPK, GetClubForm form);
043    
044    CommandResult<VoidResult> setDefaultClub(UserVisitPK userVisitPK, SetDefaultClubForm form);
045    
046    CommandResult<EditClubResult> editClub(UserVisitPK userVisitPK, EditClubForm form);
047    
048    CommandResult<VoidResult> deleteClub(UserVisitPK userVisitPK, DeleteClubForm form);
049    
050    // --------------------------------------------------------------------------------
051    //   Club Descriptions
052    // --------------------------------------------------------------------------------
053    
054    CommandResult<VoidResult> createClubDescription(UserVisitPK userVisitPK, CreateClubDescriptionForm form);
055    
056    CommandResult<GetClubDescriptionsResult> getClubDescriptions(UserVisitPK userVisitPK, GetClubDescriptionsForm form);
057    
058    CommandResult<EditClubDescriptionResult> editClubDescription(UserVisitPK userVisitPK, EditClubDescriptionForm form);
059    
060    CommandResult<VoidResult> deleteClubDescription(UserVisitPK userVisitPK, DeleteClubDescriptionForm form);
061    
062    // --------------------------------------------------------------------------------
063    //   Club Item Types
064    // --------------------------------------------------------------------------------
065    
066    CommandResult<VoidResult> createClubItemType(UserVisitPK userVisitPK, CreateClubItemTypeForm form);
067    
068    CommandResult<GetClubItemTypeChoicesResult> getClubItemTypeChoices(UserVisitPK userVisitPK, GetClubItemTypeChoicesForm form);
069    
070    // --------------------------------------------------------------------------------
071    //   Club Item Type Descriptions
072    // --------------------------------------------------------------------------------
073    
074    CommandResult<VoidResult> createClubItemTypeDescription(UserVisitPK userVisitPK, CreateClubItemTypeDescriptionForm form);
075    
076    // --------------------------------------------------------------------------------
077    //   Club Items
078    // --------------------------------------------------------------------------------
079    
080    CommandResult<VoidResult> createClubItem(UserVisitPK userVisitPK, CreateClubItemForm form);
081    
082    CommandResult<GetClubItemsResult> getClubItems(UserVisitPK userVisitPK, GetClubItemsForm form);
083    
084    CommandResult<VoidResult> deleteClubItem(UserVisitPK userVisitPK, DeleteClubItemForm form);
085    
086}