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.geo.common; 018 019import com.echothree.control.user.geo.common.form.*; 020import com.echothree.model.data.user.common.pk.UserVisitPK; 021import com.echothree.util.common.command.CommandResult; 022 023public interface GeoService 024 extends GeoForms { 025 026 // ------------------------------------------------------------------------- 027 // Testing 028 // ------------------------------------------------------------------------- 029 030 String ping(); 031 032 // ------------------------------------------------------------------------- 033 // Geo Code Types 034 // ------------------------------------------------------------------------- 035 036 CommandResult createGeoCodeType(UserVisitPK userVisitPK, CreateGeoCodeTypeForm form); 037 038 CommandResult getGeoCodeTypeChoices(UserVisitPK userVisitPK, GetGeoCodeTypeChoicesForm form); 039 040 CommandResult getGeoCodeType(UserVisitPK userVisitPK, GetGeoCodeTypeForm form); 041 042 CommandResult getGeoCodeTypes(UserVisitPK userVisitPK, GetGeoCodeTypesForm form); 043 044 CommandResult setDefaultGeoCodeType(UserVisitPK userVisitPK, SetDefaultGeoCodeTypeForm form); 045 046 CommandResult editGeoCodeType(UserVisitPK userVisitPK, EditGeoCodeTypeForm form); 047 048 CommandResult deleteGeoCodeType(UserVisitPK userVisitPK, DeleteGeoCodeTypeForm form); 049 050 // ------------------------------------------------------------------------- 051 // Geo Code Type Descriptions 052 // ------------------------------------------------------------------------- 053 054 CommandResult createGeoCodeTypeDescription(UserVisitPK userVisitPK, CreateGeoCodeTypeDescriptionForm form); 055 056 CommandResult getGeoCodeTypeDescription(UserVisitPK userVisitPK, GetGeoCodeTypeDescriptionForm form); 057 058 CommandResult getGeoCodeTypeDescriptions(UserVisitPK userVisitPK, GetGeoCodeTypeDescriptionsForm form); 059 060 CommandResult editGeoCodeTypeDescription(UserVisitPK userVisitPK, EditGeoCodeTypeDescriptionForm form); 061 062 CommandResult deleteGeoCodeTypeDescription(UserVisitPK userVisitPK, DeleteGeoCodeTypeDescriptionForm form); 063 064 // ------------------------------------------------------------------------- 065 // Geo Code Scopes 066 // ------------------------------------------------------------------------- 067 068 CommandResult createGeoCodeScope(UserVisitPK userVisitPK, CreateGeoCodeScopeForm form); 069 070 CommandResult getGeoCodeScopeChoices(UserVisitPK userVisitPK, GetGeoCodeScopeChoicesForm form); 071 072 CommandResult getGeoCodeScope(UserVisitPK userVisitPK, GetGeoCodeScopeForm form); 073 074 CommandResult getGeoCodeScopes(UserVisitPK userVisitPK, GetGeoCodeScopesForm form); 075 076 CommandResult setDefaultGeoCodeScope(UserVisitPK userVisitPK, SetDefaultGeoCodeScopeForm form); 077 078 CommandResult editGeoCodeScope(UserVisitPK userVisitPK, EditGeoCodeScopeForm form); 079 080 CommandResult deleteGeoCodeScope(UserVisitPK userVisitPK, DeleteGeoCodeScopeForm form); 081 082 // ------------------------------------------------------------------------- 083 // Geo Code Scope Descriptions 084 // ------------------------------------------------------------------------- 085 086 CommandResult createGeoCodeScopeDescription(UserVisitPK userVisitPK, CreateGeoCodeScopeDescriptionForm form); 087 088 CommandResult getGeoCodeScopeDescription(UserVisitPK userVisitPK, GetGeoCodeScopeDescriptionForm form); 089 090 CommandResult getGeoCodeScopeDescriptions(UserVisitPK userVisitPK, GetGeoCodeScopeDescriptionsForm form); 091 092 CommandResult editGeoCodeScopeDescription(UserVisitPK userVisitPK, EditGeoCodeScopeDescriptionForm form); 093 094 CommandResult deleteGeoCodeScopeDescription(UserVisitPK userVisitPK, DeleteGeoCodeScopeDescriptionForm form); 095 096 // ------------------------------------------------------------------------- 097 // Geo Code Alias Types 098 // ------------------------------------------------------------------------- 099 100 CommandResult createGeoCodeAliasType(UserVisitPK userVisitPK, CreateGeoCodeAliasTypeForm form); 101 102 CommandResult getGeoCodeAliasTypeChoices(UserVisitPK userVisitPK, GetGeoCodeAliasTypeChoicesForm form); 103 104 CommandResult getGeoCodeAliasType(UserVisitPK userVisitPK, GetGeoCodeAliasTypeForm form); 105 106 CommandResult getGeoCodeAliasTypes(UserVisitPK userVisitPK, GetGeoCodeAliasTypesForm form); 107 108 CommandResult setDefaultGeoCodeAliasType(UserVisitPK userVisitPK, SetDefaultGeoCodeAliasTypeForm form); 109 110 CommandResult editGeoCodeAliasType(UserVisitPK userVisitPK, EditGeoCodeAliasTypeForm form); 111 112 CommandResult deleteGeoCodeAliasType(UserVisitPK userVisitPK, DeleteGeoCodeAliasTypeForm form); 113 114 // ------------------------------------------------------------------------- 115 // Geo Code Alias Type Descriptions 116 // ------------------------------------------------------------------------- 117 118 CommandResult createGeoCodeAliasTypeDescription(UserVisitPK userVisitPK, CreateGeoCodeAliasTypeDescriptionForm form); 119 120 CommandResult getGeoCodeAliasTypeDescription(UserVisitPK userVisitPK, GetGeoCodeAliasTypeDescriptionForm form); 121 122 CommandResult getGeoCodeAliasTypeDescriptions(UserVisitPK userVisitPK, GetGeoCodeAliasTypeDescriptionsForm form); 123 124 CommandResult editGeoCodeAliasTypeDescription(UserVisitPK userVisitPK, EditGeoCodeAliasTypeDescriptionForm form); 125 126 CommandResult deleteGeoCodeAliasTypeDescription(UserVisitPK userVisitPK, DeleteGeoCodeAliasTypeDescriptionForm form); 127 128 // ------------------------------------------------------------------------- 129 // Geo Codes 130 // ------------------------------------------------------------------------- 131 132 CommandResult getGeoCode(UserVisitPK userVisitPK, GetGeoCodeForm form); 133 134 CommandResult setDefaultGeoCode(UserVisitPK userVisitPK, SetDefaultGeoCodeForm form); 135 136 CommandResult deleteGeoCode(UserVisitPK userVisitPK, DeleteGeoCodeForm form); 137 138 // -------------------------------------------------------------------------------- 139 // Geo Code Descriptions 140 // -------------------------------------------------------------------------------- 141 142 CommandResult createGeoCodeDescription(UserVisitPK userVisitPK, CreateGeoCodeDescriptionForm form); 143 144 CommandResult getGeoCodeDescription(UserVisitPK userVisitPK, GetGeoCodeDescriptionForm form); 145 146 CommandResult getGeoCodeDescriptions(UserVisitPK userVisitPK, GetGeoCodeDescriptionsForm form); 147 148 CommandResult editGeoCodeDescription(UserVisitPK userVisitPK, EditGeoCodeDescriptionForm form); 149 150 CommandResult deleteGeoCodeDescription(UserVisitPK userVisitPK, DeleteGeoCodeDescriptionForm form); 151 152 // ------------------------------------------------------------------------- 153 // Geo Code Aliases 154 // ------------------------------------------------------------------------- 155 156 CommandResult createGeoCodeAlias(UserVisitPK userVisitPK, CreateGeoCodeAliasForm form); 157 158 CommandResult getGeoCodeAlias(UserVisitPK userVisitPK, GetGeoCodeAliasForm form); 159 160 CommandResult getGeoCodeAliases(UserVisitPK userVisitPK, GetGeoCodeAliasesForm form); 161 162 CommandResult editGeoCodeAlias(UserVisitPK userVisitPK, EditGeoCodeAliasForm form); 163 164 CommandResult deleteGeoCodeAlias(UserVisitPK userVisitPK, DeleteGeoCodeAliasForm form); 165 166 // ------------------------------------------------------------------------- 167 // Geo Code Languages 168 // ------------------------------------------------------------------------- 169 170 CommandResult createGeoCodeLanguage(UserVisitPK userVisitPK, CreateGeoCodeLanguageForm form); 171 172 CommandResult getGeoCodeLanguage(UserVisitPK userVisitPK, GetGeoCodeLanguageForm form); 173 174 CommandResult getGeoCodeLanguages(UserVisitPK userVisitPK, GetGeoCodeLanguagesForm form); 175 176 CommandResult setDefaultGeoCodeLanguage(UserVisitPK userVisitPK, SetDefaultGeoCodeLanguageForm form); 177 178 CommandResult editGeoCodeLanguage(UserVisitPK userVisitPK, EditGeoCodeLanguageForm form); 179 180 CommandResult deleteGeoCodeLanguage(UserVisitPK userVisitPK, DeleteGeoCodeLanguageForm form); 181 182 // ------------------------------------------------------------------------- 183 // Geo Code Currencies 184 // ------------------------------------------------------------------------- 185 186 CommandResult createGeoCodeCurrency(UserVisitPK userVisitPK, CreateGeoCodeCurrencyForm form); 187 188 CommandResult getGeoCodeCurrency(UserVisitPK userVisitPK, GetGeoCodeCurrencyForm form); 189 190 CommandResult getGeoCodeCurrencies(UserVisitPK userVisitPK, GetGeoCodeCurrenciesForm form); 191 192 CommandResult setDefaultGeoCodeCurrency(UserVisitPK userVisitPK, SetDefaultGeoCodeCurrencyForm form); 193 194 CommandResult editGeoCodeCurrency(UserVisitPK userVisitPK, EditGeoCodeCurrencyForm form); 195 196 CommandResult deleteGeoCodeCurrency(UserVisitPK userVisitPK, DeleteGeoCodeCurrencyForm form); 197 198 // ------------------------------------------------------------------------- 199 // Geo Code Time Zones 200 // ------------------------------------------------------------------------- 201 202 CommandResult createGeoCodeTimeZone(UserVisitPK userVisitPK, CreateGeoCodeTimeZoneForm form); 203 204 CommandResult getGeoCodeTimeZone(UserVisitPK userVisitPK, GetGeoCodeTimeZoneForm form); 205 206 CommandResult getGeoCodeTimeZones(UserVisitPK userVisitPK, GetGeoCodeTimeZonesForm form); 207 208 CommandResult setDefaultGeoCodeTimeZone(UserVisitPK userVisitPK, SetDefaultGeoCodeTimeZoneForm form); 209 210 CommandResult editGeoCodeTimeZone(UserVisitPK userVisitPK, EditGeoCodeTimeZoneForm form); 211 212 CommandResult deleteGeoCodeTimeZone(UserVisitPK userVisitPK, DeleteGeoCodeTimeZoneForm form); 213 214 // ------------------------------------------------------------------------- 215 // Geo Code Date Time Formats 216 // ------------------------------------------------------------------------- 217 218 CommandResult createGeoCodeDateTimeFormat(UserVisitPK userVisitPK, CreateGeoCodeDateTimeFormatForm form); 219 220 CommandResult getGeoCodeDateTimeFormat(UserVisitPK userVisitPK, GetGeoCodeDateTimeFormatForm form); 221 222 CommandResult getGeoCodeDateTimeFormats(UserVisitPK userVisitPK, GetGeoCodeDateTimeFormatsForm form); 223 224 CommandResult setDefaultGeoCodeDateTimeFormat(UserVisitPK userVisitPK, SetDefaultGeoCodeDateTimeFormatForm form); 225 226 CommandResult editGeoCodeDateTimeFormat(UserVisitPK userVisitPK, EditGeoCodeDateTimeFormatForm form); 227 228 CommandResult deleteGeoCodeDateTimeFormat(UserVisitPK userVisitPK, DeleteGeoCodeDateTimeFormatForm form); 229 230 // ------------------------------------------------------------------------- 231 // Countries 232 // ------------------------------------------------------------------------- 233 234 CommandResult createCountry(UserVisitPK userVisitPK, CreateCountryForm form); 235 236 CommandResult getCountry(UserVisitPK userVisitPK, GetCountryForm form); 237 238 CommandResult getCountries(UserVisitPK userVisitPK, GetCountriesForm form); 239 240 CommandResult getCountryChoices(UserVisitPK userVisitPK, GetCountryChoicesForm form); 241 242 CommandResult editCountry(UserVisitPK userVisitPK, EditCountryForm form); 243 244 // ------------------------------------------------------------------------- 245 // States 246 // ------------------------------------------------------------------------- 247 248 CommandResult createState(UserVisitPK userVisitPK, CreateStateForm form); 249 250 CommandResult getState(UserVisitPK userVisitPK, GetStateForm form); 251 252 CommandResult getStates(UserVisitPK userVisitPK, GetStatesForm form); 253 254 // ------------------------------------------------------------------------- 255 // Counties 256 // ------------------------------------------------------------------------- 257 258 CommandResult createCounty(UserVisitPK userVisitPK, CreateCountyForm form); 259 260 CommandResult getCounty(UserVisitPK userVisitPK, GetCountyForm form); 261 262 CommandResult getCounties(UserVisitPK userVisitPK, GetCountiesForm form); 263 264 // ------------------------------------------------------------------------- 265 // Cities 266 // ------------------------------------------------------------------------- 267 268 CommandResult createCity(UserVisitPK userVisitPK, CreateCityForm form); 269 270 CommandResult addCityToCounty(UserVisitPK userVisitPK, AddCityToCountyForm form); 271 272 CommandResult addZipCodeToCity(UserVisitPK userVisitPK, AddZipCodeToCityForm form); 273 274 CommandResult getCity(UserVisitPK userVisitPK, GetCityForm form); 275 276 CommandResult getCities(UserVisitPK userVisitPK, GetCitiesForm form); 277 278 // ------------------------------------------------------------------------- 279 // Zip Codes 280 // ------------------------------------------------------------------------- 281 282 CommandResult createZipCode(UserVisitPK userVisitPK, CreateZipCodeForm form); 283 284 CommandResult getZipCode(UserVisitPK userVisitPK, GetZipCodeForm form); 285 286 CommandResult getZipCodes(UserVisitPK userVisitPK, GetZipCodesForm form); 287 288}