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