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.icon.common;
018
019import com.echothree.control.user.icon.common.form.*;
020import com.echothree.control.user.icon.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 IconService
026        extends IconForms {
027    
028    // -------------------------------------------------------------------------
029    //   Testing
030    // -------------------------------------------------------------------------
031    
032    String ping();
033    
034    // --------------------------------------------------------------------------------
035    //   Icon Usage Types
036    // --------------------------------------------------------------------------------
037    
038    CommandResult<VoidResult> createIconUsageType(UserVisitPK userVisitPK, CreateIconUsageTypeForm form);
039    
040    // --------------------------------------------------------------------------------
041    //   Icon Usage Type Descriptions
042    // --------------------------------------------------------------------------------
043    
044    CommandResult<VoidResult> createIconUsageTypeDescription(UserVisitPK userVisitPK, CreateIconUsageTypeDescriptionForm form);
045    
046    // --------------------------------------------------------------------------------
047    //   Icons
048    // --------------------------------------------------------------------------------
049    
050    CommandResult<GetIconChoicesResult> getIconChoices(UserVisitPK userVisitPK, GetIconChoicesForm form);
051    
052}