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.shipping.common;
018
019import com.echothree.control.user.shipping.common.form.*;
020import com.echothree.control.user.shipping.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 ShippingService
026        extends ShippingForms {
027    
028    // -------------------------------------------------------------------------
029    //   Testing
030    // -------------------------------------------------------------------------
031    
032    String ping();
033    
034    // -------------------------------------------------------------------------
035    //   Shipping Methods
036    // -------------------------------------------------------------------------
037    
038    CommandResult<VoidResult> createShippingMethod(UserVisitPK userVisitPK, CreateShippingMethodForm form);
039    
040    CommandResult<GetShippingMethodResult> getShippingMethod(UserVisitPK userVisitPK, GetShippingMethodForm form);
041    
042    CommandResult<GetShippingMethodsResult> getShippingMethods(UserVisitPK userVisitPK, GetShippingMethodsForm form);
043    
044    CommandResult<GetShippingMethodChoicesResult> getShippingMethodChoices(UserVisitPK userVisitPK, GetShippingMethodChoicesForm form);
045    
046    CommandResult<EditShippingMethodResult> editShippingMethod(UserVisitPK userVisitPK, EditShippingMethodForm form);
047    
048    CommandResult<VoidResult> deleteShippingMethod(UserVisitPK userVisitPK, DeleteShippingMethodForm form);
049    
050    // -------------------------------------------------------------------------
051    //   Shipping Method Descriptions
052    // -------------------------------------------------------------------------
053    
054    CommandResult<VoidResult> createShippingMethodDescription(UserVisitPK userVisitPK, CreateShippingMethodDescriptionForm form);
055    
056    CommandResult<GetShippingMethodDescriptionResult> getShippingMethodDescription(UserVisitPK userVisitPK, GetShippingMethodDescriptionForm form);
057
058    CommandResult<GetShippingMethodDescriptionsResult> getShippingMethodDescriptions(UserVisitPK userVisitPK, GetShippingMethodDescriptionsForm form);
059
060    CommandResult<EditShippingMethodDescriptionResult> editShippingMethodDescription(UserVisitPK userVisitPK, EditShippingMethodDescriptionForm form);
061    
062    CommandResult<VoidResult> deleteShippingMethodDescription(UserVisitPK userVisitPK, DeleteShippingMethodDescriptionForm form);
063    
064    // -------------------------------------------------------------------------
065    //   Shipping Method Carrier Services
066    // -------------------------------------------------------------------------
067    
068    CommandResult<VoidResult> createShippingMethodCarrierService(UserVisitPK userVisitPK, CreateShippingMethodCarrierServiceForm form);
069    
070    CommandResult<GetShippingMethodCarrierServiceResult> getShippingMethodCarrierService(UserVisitPK userVisitPK, GetShippingMethodCarrierServiceForm form);
071
072    CommandResult<GetShippingMethodCarrierServicesResult> getShippingMethodCarrierServices(UserVisitPK userVisitPK, GetShippingMethodCarrierServicesForm form);
073
074    CommandResult<VoidResult> deleteShippingMethodCarrierService(UserVisitPK userVisitPK, DeleteShippingMethodCarrierServiceForm form);
075    
076}