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.comment.common;
018
019import com.echothree.control.user.comment.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface CommentService
024        extends CommentForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // -------------------------------------------------------------------------
033    //   Comment Types
034    // -------------------------------------------------------------------------
035    
036    CommandResult createCommentType(UserVisitPK userVisitPK, CreateCommentTypeForm form);
037    
038    CommandResult getCommentType(UserVisitPK userVisitPK, GetCommentTypeForm form);
039    
040    CommandResult getCommentTypes(UserVisitPK userVisitPK, GetCommentTypesForm form);
041    
042    CommandResult editCommentType(UserVisitPK userVisitPK, EditCommentTypeForm form);
043    
044    CommandResult deleteCommentType(UserVisitPK userVisitPK, DeleteCommentTypeForm form);
045    
046    // -------------------------------------------------------------------------
047    //   Comment Type Descriptions
048    // -------------------------------------------------------------------------
049    
050    CommandResult createCommentTypeDescription(UserVisitPK userVisitPK, CreateCommentTypeDescriptionForm form);
051    
052    CommandResult getCommentTypeDescriptions(UserVisitPK userVisitPK, GetCommentTypeDescriptionsForm form);
053    
054    CommandResult editCommentTypeDescription(UserVisitPK userVisitPK, EditCommentTypeDescriptionForm form);
055    
056    CommandResult deleteCommentTypeDescription(UserVisitPK userVisitPK, DeleteCommentTypeDescriptionForm form);
057    
058    // -------------------------------------------------------------------------
059    //   Comment Usage Types
060    // -------------------------------------------------------------------------
061    
062    CommandResult createCommentUsageType(UserVisitPK userVisitPK, CreateCommentUsageTypeForm form);
063    
064    CommandResult getCommentUsageType(UserVisitPK userVisitPK, GetCommentUsageTypeForm form);
065    
066    CommandResult getCommentUsageTypes(UserVisitPK userVisitPK, GetCommentUsageTypesForm form);
067    
068    CommandResult editCommentUsageType(UserVisitPK userVisitPK, EditCommentUsageTypeForm form);
069    
070    CommandResult deleteCommentUsageType(UserVisitPK userVisitPK, DeleteCommentUsageTypeForm form);
071    
072    // -------------------------------------------------------------------------
073    //   Comment Usage Type Descriptions
074    // -------------------------------------------------------------------------
075    
076    CommandResult createCommentUsageTypeDescription(UserVisitPK userVisitPK, CreateCommentUsageTypeDescriptionForm form);
077    
078    CommandResult getCommentUsageTypeDescriptions(UserVisitPK userVisitPK, GetCommentUsageTypeDescriptionsForm form);
079    
080    CommandResult editCommentUsageTypeDescription(UserVisitPK userVisitPK, EditCommentUsageTypeDescriptionForm form);
081    
082    CommandResult deleteCommentUsageTypeDescription(UserVisitPK userVisitPK, DeleteCommentUsageTypeDescriptionForm form);
083    
084    // -------------------------------------------------------------------------
085    //   Comments
086    // -------------------------------------------------------------------------
087    
088    CommandResult createComment(UserVisitPK userVisitPK, CreateCommentForm form);
089    
090    CommandResult getComment(UserVisitPK userVisitPK, GetCommentForm form);
091    
092    CommandResult editComment(UserVisitPK userVisitPK, EditCommentForm form);
093    
094    CommandResult getCommentStatusChoices(UserVisitPK userVisitPK, GetCommentStatusChoicesForm form);
095    
096    CommandResult setCommentStatus(UserVisitPK userVisitPK, SetCommentStatusForm form);
097    
098    CommandResult deleteComment(UserVisitPK userVisitPK, DeleteCommentForm form);
099    
100    // -------------------------------------------------------------------------
101    //   Comment Usages
102    // -------------------------------------------------------------------------
103    
104    CommandResult createCommentUsage(UserVisitPK userVisitPK, CreateCommentUsageForm form);
105    
106    CommandResult deleteCommentUsage(UserVisitPK userVisitPK, DeleteCommentUsageForm form);
107    
108}