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.rating.common;
018
019import com.echothree.control.user.rating.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface RatingService
024        extends RatingForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // -------------------------------------------------------------------------
033    //   Rating Types
034    // -------------------------------------------------------------------------
035    
036    CommandResult createRatingType(UserVisitPK userVisitPK, CreateRatingTypeForm form);
037    
038    CommandResult getRatingType(UserVisitPK userVisitPK, GetRatingTypeForm form);
039    
040    CommandResult getRatingTypes(UserVisitPK userVisitPK, GetRatingTypesForm form);
041    
042    CommandResult editRatingType(UserVisitPK userVisitPK, EditRatingTypeForm form);
043    
044    CommandResult deleteRatingType(UserVisitPK userVisitPK, DeleteRatingTypeForm form);
045    
046    // -------------------------------------------------------------------------
047    //   Rating Type Descriptions
048    // -------------------------------------------------------------------------
049    
050    CommandResult createRatingTypeDescription(UserVisitPK userVisitPK, CreateRatingTypeDescriptionForm form);
051    
052    CommandResult getRatingTypeDescription(UserVisitPK userVisitPK, GetRatingTypeDescriptionForm form);
053    
054    CommandResult getRatingTypeDescriptions(UserVisitPK userVisitPK, GetRatingTypeDescriptionsForm form);
055    
056    CommandResult editRatingTypeDescription(UserVisitPK userVisitPK, EditRatingTypeDescriptionForm form);
057    
058    CommandResult deleteRatingTypeDescription(UserVisitPK userVisitPK, DeleteRatingTypeDescriptionForm form);
059    
060    // -------------------------------------------------------------------------
061    //   Rating Type List Items
062    // -------------------------------------------------------------------------
063    
064    CommandResult createRatingTypeListItem(UserVisitPK userVisitPK, CreateRatingTypeListItemForm form);
065    
066    CommandResult getRatingTypeListItem(UserVisitPK userVisitPK, GetRatingTypeListItemForm form);
067    
068    CommandResult getRatingTypeListItems(UserVisitPK userVisitPK, GetRatingTypeListItemsForm form);
069    
070    CommandResult getRatingTypeListItemChoices(UserVisitPK userVisitPK, GetRatingTypeListItemChoicesForm form);
071    
072    CommandResult setDefaultRatingTypeListItem(UserVisitPK userVisitPK, SetDefaultRatingTypeListItemForm form);
073    
074    CommandResult editRatingTypeListItem(UserVisitPK userVisitPK, EditRatingTypeListItemForm form);
075    
076    CommandResult deleteRatingTypeListItem(UserVisitPK userVisitPK, DeleteRatingTypeListItemForm form);
077    
078    // -------------------------------------------------------------------------
079    //   Rating Type List Item Descriptions
080    // -------------------------------------------------------------------------
081    
082    CommandResult createRatingTypeListItemDescription(UserVisitPK userVisitPK, CreateRatingTypeListItemDescriptionForm form);
083    
084    CommandResult getRatingTypeListItemDescription(UserVisitPK userVisitPK, GetRatingTypeListItemDescriptionForm form);
085    
086    CommandResult getRatingTypeListItemDescriptions(UserVisitPK userVisitPK, GetRatingTypeListItemDescriptionsForm form);
087    
088    CommandResult editRatingTypeListItemDescription(UserVisitPK userVisitPK, EditRatingTypeListItemDescriptionForm form);
089    
090    CommandResult deleteRatingTypeListItemDescription(UserVisitPK userVisitPK, DeleteRatingTypeListItemDescriptionForm form);
091    
092    // -------------------------------------------------------------------------
093    //   Ratings
094    // -------------------------------------------------------------------------
095    
096    CommandResult createRating(UserVisitPK userVisitPK, CreateRatingForm form);
097    
098    CommandResult getRating(UserVisitPK userVisitPK, GetRatingForm form);
099    
100    CommandResult editRating(UserVisitPK userVisitPK, EditRatingForm form);
101    
102    CommandResult deleteRating(UserVisitPK userVisitPK, DeleteRatingForm form);
103    
104}