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