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.carrier.common;
018
019import com.echothree.control.user.carrier.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface CarrierService
024        extends CarrierForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // -------------------------------------------------------------------------
033    //   Carrier Types
034    // -------------------------------------------------------------------------
035    
036    CommandResult createCarrierType(UserVisitPK userVisitPK, CreateCarrierTypeForm form);
037    
038    CommandResult getCarrierTypes(UserVisitPK userVisitPK, GetCarrierTypesForm form);
039    
040    CommandResult getCarrierTypeChoices(UserVisitPK userVisitPK, GetCarrierTypeChoicesForm form);
041    
042    // -------------------------------------------------------------------------
043    //   Carrier Type Descriptions
044    // -------------------------------------------------------------------------
045    
046    CommandResult createCarrierTypeDescription(UserVisitPK userVisitPK, CreateCarrierTypeDescriptionForm form);
047    
048    // -------------------------------------------------------------------------
049    //   Carriers
050    // -------------------------------------------------------------------------
051    
052    CommandResult createCarrier(UserVisitPK userVisitPK, CreateCarrierForm form);
053    
054    CommandResult getCarrier(UserVisitPK userVisitPK, GetCarrierForm form);
055    
056    CommandResult getCarriers(UserVisitPK userVisitPK, GetCarriersForm form);
057    
058    CommandResult getCarrierChoices(UserVisitPK userVisitPK, GetCarrierChoicesForm form);
059
060    CommandResult setDefaultCarrier(UserVisitPK userVisitPK, SetDefaultCarrierForm form);
061    
062    CommandResult deleteCarrier(UserVisitPK userVisitPK, DeleteCarrierForm form);
063    
064    // -------------------------------------------------------------------------
065    //   Carrier Services
066    // -------------------------------------------------------------------------
067    
068    CommandResult createCarrierService(UserVisitPK userVisitPK, CreateCarrierServiceForm form);
069    
070    CommandResult getCarrierService(UserVisitPK userVisitPK, GetCarrierServiceForm form);
071    
072    CommandResult getCarrierServices(UserVisitPK userVisitPK, GetCarrierServicesForm form);
073    
074    CommandResult getCarrierServiceChoices(UserVisitPK userVisitPK, GetCarrierServiceChoicesForm form);
075    
076    CommandResult setDefaultCarrierService(UserVisitPK userVisitPK, SetDefaultCarrierServiceForm form);
077    
078    CommandResult editCarrierService(UserVisitPK userVisitPK, EditCarrierServiceForm form);
079    
080    CommandResult deleteCarrierService(UserVisitPK userVisitPK, DeleteCarrierServiceForm form);
081    
082    // -------------------------------------------------------------------------
083    //   Carrier Service Descriptions
084    // -------------------------------------------------------------------------
085    
086    CommandResult createCarrierServiceDescription(UserVisitPK userVisitPK, CreateCarrierServiceDescriptionForm form);
087    
088    CommandResult getCarrierServiceDescription(UserVisitPK userVisitPK, GetCarrierServiceDescriptionForm form);
089
090    CommandResult getCarrierServiceDescriptions(UserVisitPK userVisitPK, GetCarrierServiceDescriptionsForm form);
091
092    CommandResult editCarrierServiceDescription(UserVisitPK userVisitPK, EditCarrierServiceDescriptionForm form);
093    
094    CommandResult deleteCarrierServiceDescription(UserVisitPK userVisitPK, DeleteCarrierServiceDescriptionForm form);
095    
096    // -------------------------------------------------------------------------
097    //   Carrier Options
098    // -------------------------------------------------------------------------
099    
100    CommandResult createCarrierOption(UserVisitPK userVisitPK, CreateCarrierOptionForm form);
101    
102    CommandResult getCarrierOption(UserVisitPK userVisitPK, GetCarrierOptionForm form);
103    
104    CommandResult getCarrierOptions(UserVisitPK userVisitPK, GetCarrierOptionsForm form);
105    
106    CommandResult getCarrierOptionChoices(UserVisitPK userVisitPK, GetCarrierOptionChoicesForm form);
107    
108    CommandResult setDefaultCarrierOption(UserVisitPK userVisitPK, SetDefaultCarrierOptionForm form);
109    
110    CommandResult editCarrierOption(UserVisitPK userVisitPK, EditCarrierOptionForm form);
111    
112    CommandResult deleteCarrierOption(UserVisitPK userVisitPK, DeleteCarrierOptionForm form);
113    
114    // -------------------------------------------------------------------------
115    //   Carrier Option Descriptions
116    // -------------------------------------------------------------------------
117    
118    CommandResult createCarrierOptionDescription(UserVisitPK userVisitPK, CreateCarrierOptionDescriptionForm form);
119    
120    CommandResult getCarrierOptionDescription(UserVisitPK userVisitPK, GetCarrierOptionDescriptionForm form);
121
122    CommandResult getCarrierOptionDescriptions(UserVisitPK userVisitPK, GetCarrierOptionDescriptionsForm form);
123
124    CommandResult editCarrierOptionDescription(UserVisitPK userVisitPK, EditCarrierOptionDescriptionForm form);
125    
126    CommandResult deleteCarrierOptionDescription(UserVisitPK userVisitPK, DeleteCarrierOptionDescriptionForm form);
127    
128    // -------------------------------------------------------------------------
129    //   Carrier Service Options
130    // -------------------------------------------------------------------------
131    
132    CommandResult createCarrierServiceOption(UserVisitPK userVisitPK, CreateCarrierServiceOptionForm form);
133    
134    CommandResult getCarrierServiceOption(UserVisitPK userVisitPK, GetCarrierServiceOptionForm form);
135    
136    CommandResult getCarrierServiceOptions(UserVisitPK userVisitPK, GetCarrierServiceOptionsForm form);
137    
138    CommandResult editCarrierServiceOption(UserVisitPK userVisitPK, EditCarrierServiceOptionForm form);
139    
140    CommandResult deleteCarrierServiceOption(UserVisitPK userVisitPK, DeleteCarrierServiceOptionForm form);
141    
142    // --------------------------------------------------------------------------------
143    //   Party Carriers
144    // --------------------------------------------------------------------------------
145
146    CommandResult createPartyCarrier(UserVisitPK userVisitPK, CreatePartyCarrierForm form);
147
148    CommandResult getPartyCarrier(UserVisitPK userVisitPK, GetPartyCarrierForm form);
149
150    CommandResult getPartyCarriers(UserVisitPK userVisitPK, GetPartyCarriersForm form);
151
152    CommandResult deletePartyCarrier(UserVisitPK userVisitPK, DeletePartyCarrierForm form);
153
154    // --------------------------------------------------------------------------------
155    //   Party Carrier Accounts
156    // --------------------------------------------------------------------------------
157
158    CommandResult createPartyCarrierAccount(UserVisitPK userVisitPK, CreatePartyCarrierAccountForm form);
159
160    CommandResult getPartyCarrierAccount(UserVisitPK userVisitPK, GetPartyCarrierAccountForm form);
161
162    CommandResult getPartyCarrierAccounts(UserVisitPK userVisitPK, GetPartyCarrierAccountsForm form);
163
164    CommandResult editPartyCarrierAccount(UserVisitPK userVisitPK, EditPartyCarrierAccountForm form);
165
166    CommandResult deletePartyCarrierAccount(UserVisitPK userVisitPK, DeletePartyCarrierAccountForm form);
167
168}