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.tax.common;
018
019import com.echothree.control.user.tax.common.form.*;
020import com.echothree.control.user.tax.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 TaxService
026        extends TaxForms {
027    
028    // -------------------------------------------------------------------------
029    //   Testing
030    // -------------------------------------------------------------------------
031    
032    String ping();
033    
034    // -------------------------------------------------------------------------
035    //   Tax Classifications
036    // -------------------------------------------------------------------------
037
038    CommandResult<VoidResult> createTaxClassification(UserVisitPK userVisitPK, CreateTaxClassificationForm form);
039
040    CommandResult<GetTaxClassificationsResult> getTaxClassifications(UserVisitPK userVisitPK, GetTaxClassificationsForm form);
041
042    CommandResult<GetTaxClassificationResult> getTaxClassification(UserVisitPK userVisitPK, GetTaxClassificationForm form);
043
044    CommandResult<GetTaxClassificationChoicesResult> getTaxClassificationChoices(UserVisitPK userVisitPK, GetTaxClassificationChoicesForm form);
045
046    CommandResult<VoidResult> setDefaultTaxClassification(UserVisitPK userVisitPK, SetDefaultTaxClassificationForm form);
047
048    CommandResult<EditTaxClassificationResult> editTaxClassification(UserVisitPK userVisitPK, EditTaxClassificationForm form);
049
050    CommandResult<VoidResult> deleteTaxClassification(UserVisitPK userVisitPK, DeleteTaxClassificationForm form);
051
052    // -------------------------------------------------------------------------
053    //   Tax Classification Translations
054    // -------------------------------------------------------------------------
055
056    CommandResult<VoidResult> createTaxClassificationTranslation(UserVisitPK userVisitPK, CreateTaxClassificationTranslationForm form);
057
058    CommandResult<GetTaxClassificationTranslationsResult> getTaxClassificationTranslations(UserVisitPK userVisitPK, GetTaxClassificationTranslationsForm form);
059
060    CommandResult<GetTaxClassificationTranslationResult> getTaxClassificationTranslation(UserVisitPK userVisitPK, GetTaxClassificationTranslationForm form);
061
062    CommandResult<EditTaxClassificationTranslationResult> editTaxClassificationTranslation(UserVisitPK userVisitPK, EditTaxClassificationTranslationForm form);
063
064    CommandResult<VoidResult> deleteTaxClassificationTranslation(UserVisitPK userVisitPK, DeleteTaxClassificationTranslationForm form);
065    
066    // -------------------------------------------------------------------------
067    //   Item Tax Classifications
068    // -------------------------------------------------------------------------
069
070    CommandResult<VoidResult> createItemTaxClassification(UserVisitPK userVisitPK, CreateItemTaxClassificationForm form);
071
072    CommandResult<GetItemTaxClassificationsResult> getItemTaxClassifications(UserVisitPK userVisitPK, GetItemTaxClassificationsForm form);
073
074    CommandResult<GetItemTaxClassificationResult> getItemTaxClassification(UserVisitPK userVisitPK, GetItemTaxClassificationForm form);
075
076    CommandResult<EditItemTaxClassificationResult> editItemTaxClassification(UserVisitPK userVisitPK, EditItemTaxClassificationForm form);
077
078    CommandResult<VoidResult> deleteItemTaxClassification(UserVisitPK userVisitPK, DeleteItemTaxClassificationForm form);
079
080    // -------------------------------------------------------------------------
081    //   Taxes
082    // -------------------------------------------------------------------------
083    
084    CommandResult<VoidResult> createTax(UserVisitPK userVisitPK, CreateTaxForm form);
085    
086    CommandResult<GetTaxesResult> getTaxes(UserVisitPK userVisitPK, GetTaxesForm form);
087    
088    CommandResult<GetTaxResult> getTax(UserVisitPK userVisitPK, GetTaxForm form);
089    
090    CommandResult<VoidResult> setDefaultTax(UserVisitPK userVisitPK, SetDefaultTaxForm form);
091    
092    CommandResult<EditTaxResult> editTax(UserVisitPK userVisitPK, EditTaxForm form);
093    
094    CommandResult<VoidResult> deleteTax(UserVisitPK userVisitPK, DeleteTaxForm form);
095    
096    // --------------------------------------------------------------------------------
097    //   Tax Descriptions
098    // --------------------------------------------------------------------------------
099    
100    CommandResult<VoidResult> createTaxDescription(UserVisitPK userVisitPK, CreateTaxDescriptionForm form);
101    
102    CommandResult<GetTaxDescriptionsResult> getTaxDescriptions(UserVisitPK userVisitPK, GetTaxDescriptionsForm form);
103    
104    CommandResult<EditTaxDescriptionResult> editTaxDescription(UserVisitPK userVisitPK, EditTaxDescriptionForm form);
105    
106    CommandResult<VoidResult> deleteTaxDescription(UserVisitPK userVisitPK, DeleteTaxDescriptionForm form);
107    
108    // -------------------------------------------------------------------------
109    //   Geo Code Taxes
110    // -------------------------------------------------------------------------
111    
112    CommandResult<VoidResult> createGeoCodeTax(UserVisitPK userVisitPK, CreateGeoCodeTaxForm form);
113    
114    CommandResult<GetGeoCodeTaxesResult> getGeoCodeTaxes(UserVisitPK userVisitPK, GetGeoCodeTaxesForm form);
115    
116    CommandResult<VoidResult> deleteGeoCodeTax(UserVisitPK userVisitPK, DeleteGeoCodeTaxForm form);
117    
118}