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.accounting.common; 018 019import com.echothree.control.user.accounting.common.form.*; 020import com.echothree.model.data.user.common.pk.UserVisitPK; 021import com.echothree.util.common.command.CommandResult; 022 023public interface AccountingService 024 extends AccountingForms { 025 026 // ------------------------------------------------------------------------- 027 // Testing 028 // ------------------------------------------------------------------------- 029 030 String ping(); 031 032 // ------------------------------------------------------------------------- 033 // Currencies 034 // ------------------------------------------------------------------------- 035 036 CommandResult createCurrency(UserVisitPK userVisitPK, CreateCurrencyForm form); 037 038 CommandResult setDefaultCurrency(UserVisitPK userVisitPK, SetDefaultCurrencyForm form); 039 040 CommandResult getCurrencyChoices(UserVisitPK userVisitPK, GetCurrencyChoicesForm form); 041 042 CommandResult getCurrencies(UserVisitPK userVisitPK, GetCurrenciesForm form); 043 044 CommandResult getCurrency(UserVisitPK userVisitPK, GetCurrencyForm form); 045 046 CommandResult getPreferredCurrency(UserVisitPK userVisitPK, GetPreferredCurrencyForm form); 047 048 // ------------------------------------------------------------------------- 049 // Currency Descriptions 050 // ------------------------------------------------------------------------- 051 052 CommandResult createCurrencyDescription(UserVisitPK userVisitPK, CreateCurrencyDescriptionForm form); 053 054 CommandResult getCurrencyDescriptions(UserVisitPK userVisitPK, GetCurrencyDescriptionsForm form); 055 056 // -------------------------------------------------------------------------------- 057 // Item Accounting Categories 058 // -------------------------------------------------------------------------------- 059 060 CommandResult createItemAccountingCategory(UserVisitPK userVisitPK, CreateItemAccountingCategoryForm form); 061 062 CommandResult getItemAccountingCategoryChoices(UserVisitPK userVisitPK, GetItemAccountingCategoryChoicesForm form); 063 064 CommandResult getItemAccountingCategory(UserVisitPK userVisitPK, GetItemAccountingCategoryForm form); 065 066 CommandResult getItemAccountingCategories(UserVisitPK userVisitPK, GetItemAccountingCategoriesForm form); 067 068 CommandResult setDefaultItemAccountingCategory(UserVisitPK userVisitPK, SetDefaultItemAccountingCategoryForm form); 069 070 CommandResult editItemAccountingCategory(UserVisitPK userVisitPK, EditItemAccountingCategoryForm form); 071 072 CommandResult deleteItemAccountingCategory(UserVisitPK userVisitPK, DeleteItemAccountingCategoryForm form); 073 074 // -------------------------------------------------------------------------------- 075 // Item Accounting Category Descriptions 076 // -------------------------------------------------------------------------------- 077 078 CommandResult createItemAccountingCategoryDescription(UserVisitPK userVisitPK, CreateItemAccountingCategoryDescriptionForm form); 079 080 CommandResult getItemAccountingCategoryDescription(UserVisitPK userVisitPK, GetItemAccountingCategoryDescriptionForm form); 081 082 CommandResult getItemAccountingCategoryDescriptions(UserVisitPK userVisitPK, GetItemAccountingCategoryDescriptionsForm form); 083 084 CommandResult editItemAccountingCategoryDescription(UserVisitPK userVisitPK, EditItemAccountingCategoryDescriptionForm form); 085 086 CommandResult deleteItemAccountingCategoryDescription(UserVisitPK userVisitPK, DeleteItemAccountingCategoryDescriptionForm form); 087 088 // -------------------------------------------------------------------------------- 089 // Gl Account Types 090 // -------------------------------------------------------------------------------- 091 092 CommandResult createGlAccountType(UserVisitPK userVisitPK, CreateGlAccountTypeForm form); 093 094 CommandResult getGlAccountType(UserVisitPK userVisitPK, GetGlAccountTypeForm form); 095 096 CommandResult getGlAccountTypes(UserVisitPK userVisitPK, GetGlAccountTypesForm form); 097 098 CommandResult getGlAccountTypeChoices(UserVisitPK userVisitPK, GetGlAccountTypeChoicesForm form); 099 100 // -------------------------------------------------------------------------------- 101 // Gl Account Type Descriptions 102 // -------------------------------------------------------------------------------- 103 104 CommandResult createGlAccountTypeDescription(UserVisitPK userVisitPK, CreateGlAccountTypeDescriptionForm form); 105 106 // -------------------------------------------------------------------------------- 107 // Gl Account Classes 108 // -------------------------------------------------------------------------------- 109 110 CommandResult createGlAccountClass(UserVisitPK userVisitPK, CreateGlAccountClassForm form); 111 112 CommandResult getGlAccountClassChoices(UserVisitPK userVisitPK, GetGlAccountClassChoicesForm form); 113 114 CommandResult getGlAccountClass(UserVisitPK userVisitPK, GetGlAccountClassForm form); 115 116 CommandResult getGlAccountClasses(UserVisitPK userVisitPK, GetGlAccountClassesForm form); 117 118 CommandResult setDefaultGlAccountClass(UserVisitPK userVisitPK, SetDefaultGlAccountClassForm form); 119 120 CommandResult editGlAccountClass(UserVisitPK userVisitPK, EditGlAccountClassForm form); 121 122 CommandResult deleteGlAccountClass(UserVisitPK userVisitPK, DeleteGlAccountClassForm form); 123 124 // -------------------------------------------------------------------------------- 125 // Gl Account Class Descriptions 126 // -------------------------------------------------------------------------------- 127 128 CommandResult createGlAccountClassDescription(UserVisitPK userVisitPK, CreateGlAccountClassDescriptionForm form); 129 130 CommandResult getGlAccountClassDescription(UserVisitPK userVisitPK, GetGlAccountClassDescriptionForm form); 131 132 CommandResult getGlAccountClassDescriptions(UserVisitPK userVisitPK, GetGlAccountClassDescriptionsForm form); 133 134 CommandResult editGlAccountClassDescription(UserVisitPK userVisitPK, EditGlAccountClassDescriptionForm form); 135 136 CommandResult deleteGlAccountClassDescription(UserVisitPK userVisitPK, DeleteGlAccountClassDescriptionForm form); 137 138 // -------------------------------------------------------------------------------- 139 // Gl Account Categories 140 // -------------------------------------------------------------------------------- 141 142 CommandResult createGlAccountCategory(UserVisitPK userVisitPK, CreateGlAccountCategoryForm form); 143 144 CommandResult getGlAccountCategoryChoices(UserVisitPK userVisitPK, GetGlAccountCategoryChoicesForm form); 145 146 CommandResult getGlAccountCategory(UserVisitPK userVisitPK, GetGlAccountCategoryForm form); 147 148 CommandResult getGlAccountCategories(UserVisitPK userVisitPK, GetGlAccountCategoriesForm form); 149 150 CommandResult setDefaultGlAccountCategory(UserVisitPK userVisitPK, SetDefaultGlAccountCategoryForm form); 151 152 CommandResult editGlAccountCategory(UserVisitPK userVisitPK, EditGlAccountCategoryForm form); 153 154 CommandResult deleteGlAccountCategory(UserVisitPK userVisitPK, DeleteGlAccountCategoryForm form); 155 156 // -------------------------------------------------------------------------------- 157 // Gl Account Category Descriptions 158 // -------------------------------------------------------------------------------- 159 160 CommandResult createGlAccountCategoryDescription(UserVisitPK userVisitPK, CreateGlAccountCategoryDescriptionForm form); 161 162 CommandResult getGlAccountCategoryDescription(UserVisitPK userVisitPK, GetGlAccountCategoryDescriptionForm form); 163 164 CommandResult getGlAccountCategoryDescriptions(UserVisitPK userVisitPK, GetGlAccountCategoryDescriptionsForm form); 165 166 CommandResult editGlAccountCategoryDescription(UserVisitPK userVisitPK, EditGlAccountCategoryDescriptionForm form); 167 168 CommandResult deleteGlAccountCategoryDescription(UserVisitPK userVisitPK, DeleteGlAccountCategoryDescriptionForm form); 169 170 // -------------------------------------------------------------------------------- 171 // Gl Resource Types 172 // -------------------------------------------------------------------------------- 173 174 CommandResult createGlResourceType(UserVisitPK userVisitPK, CreateGlResourceTypeForm form); 175 176 CommandResult getGlResourceTypeChoices(UserVisitPK userVisitPK, GetGlResourceTypeChoicesForm form); 177 178 CommandResult getGlResourceType(UserVisitPK userVisitPK, GetGlResourceTypeForm form); 179 180 CommandResult getGlResourceTypes(UserVisitPK userVisitPK, GetGlResourceTypesForm form); 181 182 CommandResult setDefaultGlResourceType(UserVisitPK userVisitPK, SetDefaultGlResourceTypeForm form); 183 184 CommandResult editGlResourceType(UserVisitPK userVisitPK, EditGlResourceTypeForm form); 185 186 CommandResult deleteGlResourceType(UserVisitPK userVisitPK, DeleteGlResourceTypeForm form); 187 188 // -------------------------------------------------------------------------------- 189 // Gl Resource Type Descriptions 190 // -------------------------------------------------------------------------------- 191 192 CommandResult createGlResourceTypeDescription(UserVisitPK userVisitPK, CreateGlResourceTypeDescriptionForm form); 193 194 CommandResult getGlResourceTypeDescription(UserVisitPK userVisitPK, GetGlResourceTypeDescriptionForm form); 195 196 CommandResult getGlResourceTypeDescriptions(UserVisitPK userVisitPK, GetGlResourceTypeDescriptionsForm form); 197 198 CommandResult editGlResourceTypeDescription(UserVisitPK userVisitPK, EditGlResourceTypeDescriptionForm form); 199 200 CommandResult deleteGlResourceTypeDescription(UserVisitPK userVisitPK, DeleteGlResourceTypeDescriptionForm form); 201 202 // -------------------------------------------------------------------------------- 203 // Gl Accounts 204 // -------------------------------------------------------------------------------- 205 206 CommandResult createGlAccount(UserVisitPK userVisitPK, CreateGlAccountForm form); 207 208 CommandResult getGlAccountChoices(UserVisitPK userVisitPK, GetGlAccountChoicesForm form); 209 210 CommandResult getGlAccount(UserVisitPK userVisitPK, GetGlAccountForm form); 211 212 CommandResult getGlAccounts(UserVisitPK userVisitPK, GetGlAccountsForm form); 213 214 CommandResult editGlAccount(UserVisitPK userVisitPK, EditGlAccountForm form); 215 216 CommandResult deleteGlAccount(UserVisitPK userVisitPK, DeleteGlAccountForm form); 217 218 // -------------------------------------------------------------------------------- 219 // Gl Account Descriptions 220 // -------------------------------------------------------------------------------- 221 222 CommandResult createGlAccountDescription(UserVisitPK userVisitPK, CreateGlAccountDescriptionForm form); 223 224 CommandResult getGlAccountDescription(UserVisitPK userVisitPK, GetGlAccountDescriptionForm form); 225 226 CommandResult getGlAccountDescriptions(UserVisitPK userVisitPK, GetGlAccountDescriptionsForm form); 227 228 CommandResult editGlAccountDescription(UserVisitPK userVisitPK, EditGlAccountDescriptionForm form); 229 230 CommandResult deleteGlAccountDescription(UserVisitPK userVisitPK, DeleteGlAccountDescriptionForm form); 231 232 // -------------------------------------------------------------------------------- 233 // Transaction Types 234 // -------------------------------------------------------------------------------- 235 236 CommandResult createTransactionType(UserVisitPK userVisitPK, CreateTransactionTypeForm form); 237 238 CommandResult getTransactionType(UserVisitPK userVisitPK, GetTransactionTypeForm form); 239 240 CommandResult getTransactionTypes(UserVisitPK userVisitPK, GetTransactionTypesForm form); 241 242 CommandResult editTransactionType(UserVisitPK userVisitPK, EditTransactionTypeForm form); 243 244 CommandResult deleteTransactionType(UserVisitPK userVisitPK, DeleteTransactionTypeForm form); 245 246 // -------------------------------------------------------------------------------- 247 // Transaction Type Descriptions 248 // -------------------------------------------------------------------------------- 249 250 CommandResult createTransactionTypeDescription(UserVisitPK userVisitPK, CreateTransactionTypeDescriptionForm form); 251 252 CommandResult getTransactionTypeDescription(UserVisitPK userVisitPK, GetTransactionTypeDescriptionForm form); 253 254 CommandResult getTransactionTypeDescriptions(UserVisitPK userVisitPK, GetTransactionTypeDescriptionsForm form); 255 256 CommandResult editTransactionTypeDescription(UserVisitPK userVisitPK, EditTransactionTypeDescriptionForm form); 257 258 CommandResult deleteTransactionTypeDescription(UserVisitPK userVisitPK, DeleteTransactionTypeDescriptionForm form); 259 260 // -------------------------------------------------------------------------------- 261 // Transaction Gl Account Categories 262 // -------------------------------------------------------------------------------- 263 264 CommandResult createTransactionGlAccountCategory(UserVisitPK userVisitPK, CreateTransactionGlAccountCategoryForm form); 265 266 CommandResult getTransactionGlAccountCategory(UserVisitPK userVisitPK, GetTransactionGlAccountCategoryForm form); 267 268 CommandResult getTransactionGlAccountCategories(UserVisitPK userVisitPK, GetTransactionGlAccountCategoriesForm form); 269 270 CommandResult editTransactionGlAccountCategory(UserVisitPK userVisitPK, EditTransactionGlAccountCategoryForm form); 271 272 CommandResult deleteTransactionGlAccountCategory(UserVisitPK userVisitPK, DeleteTransactionGlAccountCategoryForm form); 273 274 // -------------------------------------------------------------------------------- 275 // Transaction Gl Account Category Descriptions 276 // -------------------------------------------------------------------------------- 277 278 CommandResult createTransactionGlAccountCategoryDescription(UserVisitPK userVisitPK, CreateTransactionGlAccountCategoryDescriptionForm form); 279 280 CommandResult getTransactionGlAccountCategoryDescription(UserVisitPK userVisitPK, GetTransactionGlAccountCategoryDescriptionForm form); 281 282 CommandResult getTransactionGlAccountCategoryDescriptions(UserVisitPK userVisitPK, GetTransactionGlAccountCategoryDescriptionsForm form); 283 284 CommandResult editTransactionGlAccountCategoryDescription(UserVisitPK userVisitPK, EditTransactionGlAccountCategoryDescriptionForm form); 285 286 CommandResult deleteTransactionGlAccountCategoryDescription(UserVisitPK userVisitPK, DeleteTransactionGlAccountCategoryDescriptionForm form); 287 288 // -------------------------------------------------------------------------------- 289 // Transaction Entity Role Types 290 // -------------------------------------------------------------------------------- 291 292 CommandResult createTransactionEntityRoleType(UserVisitPK userVisitPK, CreateTransactionEntityRoleTypeForm form); 293 294 CommandResult getTransactionEntityRoleType(UserVisitPK userVisitPK, GetTransactionEntityRoleTypeForm form); 295 296 CommandResult getTransactionEntityRoleTypes(UserVisitPK userVisitPK, GetTransactionEntityRoleTypesForm form); 297 298 CommandResult editTransactionEntityRoleType(UserVisitPK userVisitPK, EditTransactionEntityRoleTypeForm form); 299 300 CommandResult deleteTransactionEntityRoleType(UserVisitPK userVisitPK, DeleteTransactionEntityRoleTypeForm form); 301 302 // -------------------------------------------------------------------------------- 303 // Transaction Entity Role Type Descriptions 304 // -------------------------------------------------------------------------------- 305 306 CommandResult createTransactionEntityRoleTypeDescription(UserVisitPK userVisitPK, CreateTransactionEntityRoleTypeDescriptionForm form); 307 308 CommandResult getTransactionEntityRoleTypeDescription(UserVisitPK userVisitPK, GetTransactionEntityRoleTypeDescriptionForm form); 309 310 CommandResult getTransactionEntityRoleTypeDescriptions(UserVisitPK userVisitPK, GetTransactionEntityRoleTypeDescriptionsForm form); 311 312 CommandResult editTransactionEntityRoleTypeDescription(UserVisitPK userVisitPK, EditTransactionEntityRoleTypeDescriptionForm form); 313 314 CommandResult deleteTransactionEntityRoleTypeDescription(UserVisitPK userVisitPK, DeleteTransactionEntityRoleTypeDescriptionForm form); 315 316 // -------------------------------------------------------------------------------- 317 // Transaction Groups 318 // -------------------------------------------------------------------------------- 319 320 CommandResult getTransactionGroups(UserVisitPK userVisitPK, GetTransactionGroupsForm form); 321 322 CommandResult getTransactionGroup(UserVisitPK userVisitPK, GetTransactionGroupForm form); 323 324 CommandResult getTransactionGroupStatusChoices(UserVisitPK userVisitPK, GetTransactionGroupStatusChoicesForm form); 325 326 CommandResult setTransactionGroupStatus(UserVisitPK userVisitPK, SetTransactionGroupStatusForm form); 327 328 // -------------------------------------------------------------------------------- 329 // Transactions 330 // -------------------------------------------------------------------------------- 331 332 CommandResult getTransactions(UserVisitPK userVisitPK, GetTransactionsForm form); 333 334 CommandResult getTransaction(UserVisitPK userVisitPK, GetTransactionForm form); 335 336 // -------------------------------------------------------------------------------- 337 // Symbol Positions 338 // -------------------------------------------------------------------------------- 339 340 CommandResult createSymbolPosition(UserVisitPK userVisitPK, CreateSymbolPositionForm form); 341 342 CommandResult getSymbolPositionChoices(UserVisitPK userVisitPK, GetSymbolPositionChoicesForm form); 343 344 CommandResult getSymbolPosition(UserVisitPK userVisitPK, GetSymbolPositionForm form); 345 346 CommandResult getSymbolPositions(UserVisitPK userVisitPK, GetSymbolPositionsForm form); 347 348 CommandResult setDefaultSymbolPosition(UserVisitPK userVisitPK, SetDefaultSymbolPositionForm form); 349 350 CommandResult editSymbolPosition(UserVisitPK userVisitPK, EditSymbolPositionForm form); 351 352 CommandResult deleteSymbolPosition(UserVisitPK userVisitPK, DeleteSymbolPositionForm form); 353 354 // -------------------------------------------------------------------------------- 355 // Symbol Position Descriptions 356 // -------------------------------------------------------------------------------- 357 358 CommandResult createSymbolPositionDescription(UserVisitPK userVisitPK, CreateSymbolPositionDescriptionForm form); 359 360 CommandResult getSymbolPositionDescription(UserVisitPK userVisitPK, GetSymbolPositionDescriptionForm form); 361 362 CommandResult getSymbolPositionDescriptions(UserVisitPK userVisitPK, GetSymbolPositionDescriptionsForm form); 363 364 CommandResult editSymbolPositionDescription(UserVisitPK userVisitPK, EditSymbolPositionDescriptionForm form); 365 366 CommandResult deleteSymbolPositionDescription(UserVisitPK userVisitPK, DeleteSymbolPositionDescriptionForm form); 367 368}