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.party.common; 018 019import com.echothree.control.user.party.common.form.*; 020import com.echothree.model.data.user.common.pk.UserVisitPK; 021import com.echothree.util.common.command.CommandResult; 022 023public interface PartyService 024 extends PartyForms { 025 026 // ------------------------------------------------------------------------- 027 // Testing 028 // ------------------------------------------------------------------------- 029 030 String ping(); 031 032 // ------------------------------------------------------------------------- 033 // Languages 034 // ------------------------------------------------------------------------- 035 036 CommandResult createLanguage(UserVisitPK userVisitPK, CreateLanguageForm form); 037 038 CommandResult getLanguageChoices(UserVisitPK userVisitPK, GetLanguageChoicesForm form); 039 040 CommandResult getLanguages(UserVisitPK userVisitPK, GetLanguagesForm form); 041 042 CommandResult getLanguage(UserVisitPK userVisitPK, GetLanguageForm form); 043 044 CommandResult getPreferredLanguage(UserVisitPK userVisitPK, GetPreferredLanguageForm form); 045 046 // ------------------------------------------------------------------------- 047 // Language Descriptions 048 // ------------------------------------------------------------------------- 049 050 CommandResult createLanguageDescription(UserVisitPK userVisitPK, CreateLanguageDescriptionForm form); 051 052 // ------------------------------------------------------------------------- 053 // Party Types 054 // ------------------------------------------------------------------------- 055 056 CommandResult createPartyType(UserVisitPK userVisitPK, CreatePartyTypeForm form); 057 058 CommandResult getPartyType(UserVisitPK userVisitPK, GetPartyTypeForm form); 059 060 CommandResult getPartyTypes(UserVisitPK userVisitPK, GetPartyTypesForm form); 061 062 CommandResult getPartyTypeChoices(UserVisitPK userVisitPK, GetPartyTypeChoicesForm form); 063 064 // ------------------------------------------------------------------------- 065 // Party Type Descriptions 066 // ------------------------------------------------------------------------- 067 068 CommandResult createPartyTypeDescription(UserVisitPK userVisitPK, CreatePartyTypeDescriptionForm form); 069 070 // ------------------------------------------------------------------------- 071 // Party Type Use Types 072 // ------------------------------------------------------------------------- 073 074 CommandResult createPartyTypeUseType(UserVisitPK userVisitPK, CreatePartyTypeUseTypeForm form); 075 076 // ------------------------------------------------------------------------- 077 // Party Type Use Type Descriptions 078 // ------------------------------------------------------------------------- 079 080 CommandResult createPartyTypeUseTypeDescription(UserVisitPK userVisitPK, CreatePartyTypeUseTypeDescriptionForm form); 081 082 // ------------------------------------------------------------------------- 083 // Party Type Uses 084 // ------------------------------------------------------------------------- 085 086 CommandResult createPartyTypeUse(UserVisitPK userVisitPK, CreatePartyTypeUseForm form); 087 088 // ------------------------------------------------------------------------- 089 // Party Type Password String Policies 090 // ------------------------------------------------------------------------- 091 092 CommandResult createPartyTypePasswordStringPolicy(UserVisitPK userVisitPK, CreatePartyTypePasswordStringPolicyForm form); 093 094 CommandResult editPartyTypePasswordStringPolicy(UserVisitPK userVisitPK, EditPartyTypePasswordStringPolicyForm form); 095 096 CommandResult deletePartyTypePasswordStringPolicy(UserVisitPK userVisitPK, DeletePartyTypePasswordStringPolicyForm form); 097 098 // ------------------------------------------------------------------------- 099 // Party Type Lockout Policies 100 // ------------------------------------------------------------------------- 101 102 CommandResult createPartyTypeLockoutPolicy(UserVisitPK userVisitPK, CreatePartyTypeLockoutPolicyForm form); 103 104 CommandResult editPartyTypeLockoutPolicy(UserVisitPK userVisitPK, EditPartyTypeLockoutPolicyForm form); 105 106 CommandResult deletePartyTypeLockoutPolicy(UserVisitPK userVisitPK, DeletePartyTypeLockoutPolicyForm form); 107 108 // ------------------------------------------------------------------------- 109 // Party Type Audit Policies 110 // ------------------------------------------------------------------------- 111 112 CommandResult createPartyTypeAuditPolicy(UserVisitPK userVisitPK, CreatePartyTypeAuditPolicyForm form); 113 114 CommandResult editPartyTypeAuditPolicy(UserVisitPK userVisitPK, EditPartyTypeAuditPolicyForm form); 115 116 CommandResult deletePartyTypeAuditPolicy(UserVisitPK userVisitPK, DeletePartyTypeAuditPolicyForm form); 117 118 // ------------------------------------------------------------------------- 119 // Personal Titles 120 // ------------------------------------------------------------------------- 121 122 CommandResult createPersonalTitle(UserVisitPK userVisitPK, CreatePersonalTitleForm form); 123 124 CommandResult getPersonalTitleChoices(UserVisitPK userVisitPK, GetPersonalTitleChoicesForm form); 125 126 CommandResult getPersonalTitles(UserVisitPK userVisitPK, GetPersonalTitlesForm form); 127 128 CommandResult setDefaultPersonalTitle(UserVisitPK userVisitPK, SetDefaultPersonalTitleForm form); 129 130 CommandResult editPersonalTitle(UserVisitPK userVisitPK, EditPersonalTitleForm form); 131 132 CommandResult deletePersonalTitle(UserVisitPK userVisitPK, DeletePersonalTitleForm form); 133 134 // ------------------------------------------------------------------------- 135 // Name Suffixes 136 // ------------------------------------------------------------------------- 137 138 CommandResult createNameSuffix(UserVisitPK userVisitPK, CreateNameSuffixForm form); 139 140 CommandResult getNameSuffixChoices(UserVisitPK userVisitPK, GetNameSuffixChoicesForm form); 141 142 CommandResult getNameSuffixes(UserVisitPK userVisitPK, GetNameSuffixesForm form); 143 144 CommandResult setDefaultNameSuffix(UserVisitPK userVisitPK, SetDefaultNameSuffixForm form); 145 146 CommandResult editNameSuffix(UserVisitPK userVisitPK, EditNameSuffixForm form); 147 148 CommandResult deleteNameSuffix(UserVisitPK userVisitPK, DeleteNameSuffixForm form); 149 150 // ------------------------------------------------------------------------- 151 // Date Time Formats 152 // ------------------------------------------------------------------------- 153 154 CommandResult createDateTimeFormat(UserVisitPK userVisitPK, CreateDateTimeFormatForm form); 155 156 CommandResult getDateTimeFormatChoices(UserVisitPK userVisitPK, GetDateTimeFormatChoicesForm getDateTimeFormatChoicesForm); 157 158 CommandResult getDateTimeFormat(UserVisitPK userVisitPK, GetDateTimeFormatForm form); 159 160 CommandResult getPreferredDateTimeFormat(UserVisitPK userVisitPK, GetPreferredDateTimeFormatForm form); 161 162 CommandResult getDateTimeFormats(UserVisitPK userVisitPK, GetDateTimeFormatsForm form); 163 164 // ------------------------------------------------------------------------- 165 // Date Time Format Descriptions 166 // ------------------------------------------------------------------------- 167 168 CommandResult createDateTimeFormatDescription(UserVisitPK userVisitPK, CreateDateTimeFormatDescriptionForm form); 169 170 CommandResult getDateTimeFormatDescriptions(UserVisitPK userVisitPK, GetDateTimeFormatDescriptionsForm form); 171 172 CommandResult editDateTimeFormatDescription(UserVisitPK userVisitPK, EditDateTimeFormatDescriptionForm form); 173 174 CommandResult deleteDateTimeFormatDescription(UserVisitPK userVisitPK, DeleteDateTimeFormatDescriptionForm form); 175 176 // ------------------------------------------------------------------------- 177 // Time Zones 178 // ------------------------------------------------------------------------- 179 180 CommandResult createTimeZone(UserVisitPK userVisitPK, CreateTimeZoneForm form); 181 182 CommandResult getTimeZoneChoices(UserVisitPK userVisitPK, GetTimeZoneChoicesForm form); 183 184 CommandResult getTimeZone(UserVisitPK userVisitPK, GetTimeZoneForm form); 185 186 CommandResult getPreferredTimeZone(UserVisitPK userVisitPK, GetPreferredTimeZoneForm form); 187 188 CommandResult getTimeZones(UserVisitPK userVisitPK, GetTimeZonesForm form); 189 190 // ------------------------------------------------------------------------- 191 // Time Zone Descriptions 192 // ------------------------------------------------------------------------- 193 194 CommandResult createTimeZoneDescription(UserVisitPK userVisitPK, CreateTimeZoneDescriptionForm form); 195 196 CommandResult getTimeZoneDescriptions(UserVisitPK userVisitPK, GetTimeZoneDescriptionsForm form); 197 198 CommandResult editTimeZoneDescription(UserVisitPK userVisitPK, EditTimeZoneDescriptionForm form); 199 200 CommandResult deleteTimeZoneDescription(UserVisitPK userVisitPK, DeleteTimeZoneDescriptionForm form); 201 202 // ------------------------------------------------------------------------- 203 // Companies 204 // ------------------------------------------------------------------------- 205 206 CommandResult createCompany(UserVisitPK userVisitPK, CreateCompanyForm form); 207 208 CommandResult getCompanyChoices(UserVisitPK userVisitPK, GetCompanyChoicesForm form); 209 210 CommandResult getCompanies(UserVisitPK userVisitPK, GetCompaniesForm form); 211 212 CommandResult getCompany(UserVisitPK userVisitPK, GetCompanyForm form); 213 214 CommandResult setDefaultCompany(UserVisitPK userVisitPK, SetDefaultCompanyForm form); 215 216 CommandResult editCompany(UserVisitPK userVisitPK, EditCompanyForm form); 217 218 CommandResult deleteCompany(UserVisitPK userVisitPK, DeleteCompanyForm form); 219 220 // ------------------------------------------------------------------------- 221 // Divisions 222 // ------------------------------------------------------------------------- 223 224 CommandResult createDivision(UserVisitPK userVisitPK, CreateDivisionForm form); 225 226 CommandResult getDivisionChoices(UserVisitPK userVisitPK, GetDivisionChoicesForm form); 227 228 CommandResult getDivisions(UserVisitPK userVisitPK, GetDivisionsForm form); 229 230 CommandResult getDivision(UserVisitPK userVisitPK, GetDivisionForm form); 231 232 CommandResult setDefaultDivision(UserVisitPK userVisitPK, SetDefaultDivisionForm form); 233 234 CommandResult editDivision(UserVisitPK userVisitPK, EditDivisionForm form); 235 236 CommandResult deleteDivision(UserVisitPK userVisitPK, DeleteDivisionForm form); 237 238 // ------------------------------------------------------------------------- 239 // Departments 240 // ------------------------------------------------------------------------- 241 242 CommandResult createDepartment(UserVisitPK userVisitPK, CreateDepartmentForm form); 243 244 CommandResult getDepartmentChoices(UserVisitPK userVisitPK, GetDepartmentChoicesForm form); 245 246 CommandResult getDepartments(UserVisitPK userVisitPK, GetDepartmentsForm form); 247 248 CommandResult getDepartment(UserVisitPK userVisitPK, GetDepartmentForm form); 249 250 CommandResult setDefaultDepartment(UserVisitPK userVisitPK, SetDefaultDepartmentForm form); 251 252 CommandResult editDepartment(UserVisitPK userVisitPK, EditDepartmentForm form); 253 254 CommandResult deleteDepartment(UserVisitPK userVisitPK, DeleteDepartmentForm form); 255 256 // ------------------------------------------------------------------------- 257 // Customers 258 // ------------------------------------------------------------------------- 259 260 CommandResult createCustomer(UserVisitPK userVisitPK, CreateCustomerForm form); 261 262 CommandResult createCustomerWithLogin(UserVisitPK userVisitPK, CreateCustomerWithLoginForm createCustomerWithLoginForm); 263 264 // -------------------------------------------------------------------------------- 265 // Employees 266 // -------------------------------------------------------------------------------- 267 268 CommandResult createEmployee(UserVisitPK userVisitPK, CreateEmployeeForm form); 269 270 CommandResult addEmployeeToCompany(UserVisitPK userVisitPK, AddEmployeeToCompanyForm form); 271 272 CommandResult addEmployeeToDivision(UserVisitPK userVisitPK, AddEmployeeToDivisionForm form); 273 274 CommandResult addEmployeeToDepartment(UserVisitPK userVisitPK, AddEmployeeToDepartmentForm form); 275 276 CommandResult removeEmployeeFromCompany(UserVisitPK userVisitPK, RemoveEmployeeFromCompanyForm form); 277 278 CommandResult removeEmployeeFromDivision(UserVisitPK userVisitPK, RemoveEmployeeFromDivisionForm form); 279 280 CommandResult removeEmployeeFromDepartment(UserVisitPK userVisitPK, RemoveEmployeeFromDepartmentForm form); 281 282 CommandResult getEmployeeStatusChoices(UserVisitPK userVisitPK, GetEmployeeStatusChoicesForm form); 283 284 CommandResult setEmployeeStatus(UserVisitPK userVisitPK, SetEmployeeStatusForm form); 285 286 CommandResult getEmployeeAvailabilityChoices(UserVisitPK userVisitPK, GetEmployeeAvailabilityChoicesForm form); 287 288 CommandResult setEmployeeAvailability(UserVisitPK userVisitPK, SetEmployeeAvailabilityForm form); 289 290 CommandResult editEmployee(UserVisitPK userVisitPK, EditEmployeeForm form); 291 292 // -------------------------------------------------------------------------------- 293 // Party Relationship Types 294 // -------------------------------------------------------------------------------- 295 296 CommandResult createPartyRelationshipType(UserVisitPK userVisitPK, CreatePartyRelationshipTypeForm form); 297 298 // -------------------------------------------------------------------------------- 299 // Party Relationship Type Descriptions 300 // -------------------------------------------------------------------------------- 301 302 CommandResult createPartyRelationshipTypeDescription(UserVisitPK userVisitPK, CreatePartyRelationshipTypeDescriptionForm form); 303 304 // -------------------------------------------------------------------------------- 305 // Party Relationships 306 // -------------------------------------------------------------------------------- 307 308 CommandResult getPartyRelationships(UserVisitPK userVisitPK, GetPartyRelationshipsForm form); 309 310 CommandResult getPartyRelationship(UserVisitPK userVisitPK, GetPartyRelationshipForm form); 311 312 // -------------------------------------------------------------------------------- 313 // Role Types 314 // -------------------------------------------------------------------------------- 315 316 CommandResult createRoleType(UserVisitPK userVisitPK, CreateRoleTypeForm form); 317 318 // -------------------------------------------------------------------------------- 319 // Role Type Descriptions 320 // -------------------------------------------------------------------------------- 321 322 CommandResult createRoleTypeDescription(UserVisitPK userVisitPK, CreateRoleTypeDescriptionForm form); 323 324 // -------------------------------------------------------------------------------- 325 // Vendors 326 // -------------------------------------------------------------------------------- 327 328 CommandResult createVendor(UserVisitPK userVisitPK, CreateVendorForm form); 329 330 CommandResult getVendorStatusChoices(UserVisitPK userVisitPK, GetVendorStatusChoicesForm form); 331 332 CommandResult setVendorStatus(UserVisitPK userVisitPK, SetVendorStatusForm form); 333 334 // -------------------------------------------------------------------------------- 335 // Genders 336 // -------------------------------------------------------------------------------- 337 338 CommandResult createGender(UserVisitPK userVisitPK, CreateGenderForm form); 339 340 CommandResult getGenderChoices(UserVisitPK userVisitPK, GetGenderChoicesForm form); 341 342 CommandResult getGender(UserVisitPK userVisitPK, GetGenderForm form); 343 344 CommandResult getGenders(UserVisitPK userVisitPK, GetGendersForm form); 345 346 CommandResult setDefaultGender(UserVisitPK userVisitPK, SetDefaultGenderForm form); 347 348 CommandResult editGender(UserVisitPK userVisitPK, EditGenderForm form); 349 350 CommandResult deleteGender(UserVisitPK userVisitPK, DeleteGenderForm form); 351 352 // -------------------------------------------------------------------------------- 353 // Gender Descriptions 354 // -------------------------------------------------------------------------------- 355 356 CommandResult createGenderDescription(UserVisitPK userVisitPK, CreateGenderDescriptionForm form); 357 358 CommandResult getGenderDescriptions(UserVisitPK userVisitPK, GetGenderDescriptionsForm form); 359 360 CommandResult editGenderDescription(UserVisitPK userVisitPK, EditGenderDescriptionForm form); 361 362 CommandResult deleteGenderDescription(UserVisitPK userVisitPK, DeleteGenderDescriptionForm form); 363 364 // -------------------------------------------------------------------------------- 365 // Moods 366 // -------------------------------------------------------------------------------- 367 368 CommandResult createMood(UserVisitPK userVisitPK, CreateMoodForm form); 369 370 CommandResult getMoodChoices(UserVisitPK userVisitPK, GetMoodChoicesForm form); 371 372 CommandResult getMood(UserVisitPK userVisitPK, GetMoodForm form); 373 374 CommandResult getMoods(UserVisitPK userVisitPK, GetMoodsForm form); 375 376 CommandResult setDefaultMood(UserVisitPK userVisitPK, SetDefaultMoodForm form); 377 378 CommandResult editMood(UserVisitPK userVisitPK, EditMoodForm form); 379 380 CommandResult deleteMood(UserVisitPK userVisitPK, DeleteMoodForm form); 381 382 // -------------------------------------------------------------------------------- 383 // Mood Descriptions 384 // -------------------------------------------------------------------------------- 385 386 CommandResult createMoodDescription(UserVisitPK userVisitPK, CreateMoodDescriptionForm form); 387 388 CommandResult getMoodDescriptions(UserVisitPK userVisitPK, GetMoodDescriptionsForm form); 389 390 CommandResult editMoodDescription(UserVisitPK userVisitPK, EditMoodDescriptionForm form); 391 392 CommandResult deleteMoodDescription(UserVisitPK userVisitPK, DeleteMoodDescriptionForm form); 393 394 // -------------------------------------------------------------------------------- 395 // Birthday Formats 396 // -------------------------------------------------------------------------------- 397 398 CommandResult createBirthdayFormat(UserVisitPK userVisitPK, CreateBirthdayFormatForm form); 399 400 CommandResult getBirthdayFormatChoices(UserVisitPK userVisitPK, GetBirthdayFormatChoicesForm form); 401 402 CommandResult getBirthdayFormat(UserVisitPK userVisitPK, GetBirthdayFormatForm form); 403 404 CommandResult getBirthdayFormats(UserVisitPK userVisitPK, GetBirthdayFormatsForm form); 405 406 CommandResult setDefaultBirthdayFormat(UserVisitPK userVisitPK, SetDefaultBirthdayFormatForm form); 407 408 CommandResult editBirthdayFormat(UserVisitPK userVisitPK, EditBirthdayFormatForm form); 409 410 CommandResult deleteBirthdayFormat(UserVisitPK userVisitPK, DeleteBirthdayFormatForm form); 411 412 // -------------------------------------------------------------------------------- 413 // Birthday Format Descriptions 414 // -------------------------------------------------------------------------------- 415 416 CommandResult createBirthdayFormatDescription(UserVisitPK userVisitPK, CreateBirthdayFormatDescriptionForm form); 417 418 CommandResult getBirthdayFormatDescription(UserVisitPK userVisitPK, GetBirthdayFormatDescriptionForm form); 419 420 CommandResult getBirthdayFormatDescriptions(UserVisitPK userVisitPK, GetBirthdayFormatDescriptionsForm form); 421 422 CommandResult editBirthdayFormatDescription(UserVisitPK userVisitPK, EditBirthdayFormatDescriptionForm form); 423 424 CommandResult deleteBirthdayFormatDescription(UserVisitPK userVisitPK, DeleteBirthdayFormatDescriptionForm form); 425 426 // -------------------------------------------------------------------------------- 427 // Profiles 428 // -------------------------------------------------------------------------------- 429 430 CommandResult createProfile(UserVisitPK userVisitPK, CreateProfileForm form); 431 432 CommandResult editProfile(UserVisitPK userVisitPK, EditProfileForm form); 433 434 // -------------------------------------------------------------------------------- 435 // Party Alias Types 436 // -------------------------------------------------------------------------------- 437 438 CommandResult createPartyAliasType(UserVisitPK userVisitPK, CreatePartyAliasTypeForm form); 439 440 CommandResult getPartyAliasTypeChoices(UserVisitPK userVisitPK, GetPartyAliasTypeChoicesForm form); 441 442 CommandResult getPartyAliasType(UserVisitPK userVisitPK, GetPartyAliasTypeForm form); 443 444 CommandResult getPartyAliasTypes(UserVisitPK userVisitPK, GetPartyAliasTypesForm form); 445 446 CommandResult setDefaultPartyAliasType(UserVisitPK userVisitPK, SetDefaultPartyAliasTypeForm form); 447 448 CommandResult editPartyAliasType(UserVisitPK userVisitPK, EditPartyAliasTypeForm form); 449 450 CommandResult deletePartyAliasType(UserVisitPK userVisitPK, DeletePartyAliasTypeForm form); 451 452 // -------------------------------------------------------------------------------- 453 // Party Alias Type Descriptions 454 // -------------------------------------------------------------------------------- 455 456 CommandResult createPartyAliasTypeDescription(UserVisitPK userVisitPK, CreatePartyAliasTypeDescriptionForm form); 457 458 CommandResult getPartyAliasTypeDescription(UserVisitPK userVisitPK, GetPartyAliasTypeDescriptionForm form); 459 460 CommandResult getPartyAliasTypeDescriptions(UserVisitPK userVisitPK, GetPartyAliasTypeDescriptionsForm form); 461 462 CommandResult editPartyAliasTypeDescription(UserVisitPK userVisitPK, EditPartyAliasTypeDescriptionForm form); 463 464 CommandResult deletePartyAliasTypeDescription(UserVisitPK userVisitPK, DeletePartyAliasTypeDescriptionForm form); 465 466 // -------------------------------------------------------------------------------- 467 // Party Aliases 468 // -------------------------------------------------------------------------------- 469 470 CommandResult createPartyAlias(UserVisitPK userVisitPK, CreatePartyAliasForm form); 471 472 CommandResult getPartyAlias(UserVisitPK userVisitPK, GetPartyAliasForm form); 473 474 CommandResult getPartyAliases(UserVisitPK userVisitPK, GetPartyAliasesForm form); 475 476 CommandResult editPartyAlias(UserVisitPK userVisitPK, EditPartyAliasForm form); 477 478 CommandResult deletePartyAlias(UserVisitPK userVisitPK, DeletePartyAliasForm form); 479 480 // ------------------------------------------------------------------------- 481 // Parties 482 // ------------------------------------------------------------------------- 483 484 CommandResult getParty(UserVisitPK userVisitPK, GetPartyForm form); 485 486 CommandResult getParties(UserVisitPK userVisitPK, GetPartiesForm form); 487 488}