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.license.common;
018
019import com.echothree.control.user.license.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface LicenseService
024        extends LicenseForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // --------------------------------------------------------------------------------
033    //   License Types
034    // --------------------------------------------------------------------------------
035    
036    CommandResult createLicenseType(UserVisitPK userVisitPK, CreateLicenseTypeForm form);
037    
038    CommandResult getLicenseTypeChoices(UserVisitPK userVisitPK, GetLicenseTypeChoicesForm form);
039    
040    CommandResult getLicenseType(UserVisitPK userVisitPK, GetLicenseTypeForm form);
041    
042    CommandResult getLicenseTypes(UserVisitPK userVisitPK, GetLicenseTypesForm form);
043    
044    CommandResult setDefaultLicenseType(UserVisitPK userVisitPK, SetDefaultLicenseTypeForm form);
045    
046    CommandResult editLicenseType(UserVisitPK userVisitPK, EditLicenseTypeForm form);
047    
048    CommandResult deleteLicenseType(UserVisitPK userVisitPK, DeleteLicenseTypeForm form);
049    
050    // --------------------------------------------------------------------------------
051    //   License Type Descriptions
052    // --------------------------------------------------------------------------------
053    
054    CommandResult createLicenseTypeDescription(UserVisitPK userVisitPK, CreateLicenseTypeDescriptionForm form);
055    
056    CommandResult getLicenseTypeDescription(UserVisitPK userVisitPK, GetLicenseTypeDescriptionForm form);
057    
058    CommandResult getLicenseTypeDescriptions(UserVisitPK userVisitPK, GetLicenseTypeDescriptionsForm form);
059    
060    CommandResult editLicenseTypeDescription(UserVisitPK userVisitPK, EditLicenseTypeDescriptionForm form);
061    
062    CommandResult deleteLicenseTypeDescription(UserVisitPK userVisitPK, DeleteLicenseTypeDescriptionForm form);
063    
064    // --------------------------------------------------------------------------------
065    //   License Utilities
066    // --------------------------------------------------------------------------------
067    
068    CommandResult updateLicense(UserVisitPK userVisitPK);
069    
070}