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