From bc9556059826275ffa7cfffe919f7c52df4137aa Mon Sep 17 00:00:00 2001 From: Kristina Lim Date: Thu, 24 Jan 2019 02:41:41 +0800 Subject: [PATCH] Add descriptions for data representation classes --- .../data_representations/coordinator_fee.rb | 3 +++ .../data_representations/exchange_order_fee.rb | 3 +++ .../incoming_exchange_line_item_fee.rb | 3 +++ .../outgoing_exchange_line_item_fee.rb | 3 +++ .../data_representations/payment_method_fee.rb | 3 +++ .../data_representations/shipping_method_fee.rb | 3 +++ .../data_representations/using_enterprise_fee.rb | 7 +++++++ 7 files changed, 25 insertions(+) diff --git a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/coordinator_fee.rb b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/coordinator_fee.rb index 2d5c61eb06..eac30edc66 100644 --- a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/coordinator_fee.rb +++ b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/coordinator_fee.rb @@ -1,3 +1,6 @@ +# This module provides EnterpriseFeeSummary::Scope DB result to report mappings for coordinator fees +# in an order cycle. + module OrderManagement module Reports module EnterpriseFeeSummary diff --git a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/exchange_order_fee.rb b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/exchange_order_fee.rb index ebea9229e6..2e33fb0649 100644 --- a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/exchange_order_fee.rb +++ b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/exchange_order_fee.rb @@ -1,3 +1,6 @@ +# This module provides EnterpriseFeeSummary::Scope DB result to report mappings for exchange fees +# that use order-based calculators. + module OrderManagement module Reports module EnterpriseFeeSummary diff --git a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/incoming_exchange_line_item_fee.rb b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/incoming_exchange_line_item_fee.rb index 69589fd3e3..cb51c46def 100644 --- a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/incoming_exchange_line_item_fee.rb +++ b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/incoming_exchange_line_item_fee.rb @@ -1,3 +1,6 @@ +# This module provides EnterpriseFeeSummary::Scope DB result to report mappings for incoming +# exchange fees that use line item -based calculators. + module OrderManagement module Reports module EnterpriseFeeSummary diff --git a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/outgoing_exchange_line_item_fee.rb b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/outgoing_exchange_line_item_fee.rb index 61383daddd..9598e34654 100644 --- a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/outgoing_exchange_line_item_fee.rb +++ b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/outgoing_exchange_line_item_fee.rb @@ -1,3 +1,6 @@ +# This module provides EnterpriseFeeSummary::Scope DB result to report mappings for outgoing +# exchange fees that use line item -based calculators. + module OrderManagement module Reports module EnterpriseFeeSummary diff --git a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/payment_method_fee.rb b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/payment_method_fee.rb index 9e48501e66..5427e52a95 100644 --- a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/payment_method_fee.rb +++ b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/payment_method_fee.rb @@ -1,3 +1,6 @@ +# This module provides EnterpriseFeeSummary::Scope DB result to report mappings for payment method +# fees. + module OrderManagement module Reports module EnterpriseFeeSummary diff --git a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/shipping_method_fee.rb b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/shipping_method_fee.rb index 6d8d6cea6c..c845dfacb8 100644 --- a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/shipping_method_fee.rb +++ b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/shipping_method_fee.rb @@ -1,3 +1,6 @@ +# This module provides EnterpriseFeeSummary::Scope DB result to report mappings for shipping method +# fees. + module OrderManagement module Reports module EnterpriseFeeSummary diff --git a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/using_enterprise_fee.rb b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/using_enterprise_fee.rb index f265164969..7fe5d7b4e0 100644 --- a/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/using_enterprise_fee.rb +++ b/engines/order_management/app/services/order_management/reports/enterprise_fee_summary/data_representations/using_enterprise_fee.rb @@ -1,3 +1,10 @@ +# Different EnterpriseFeeSummary::Scope DB result attributes are checked when dealing with +# enterprise fees that are attached to an order cycle in different ways. +# +# This module provides DB result to report mappings that are common among all rows for enterprise +# fees. These mappings are not complete and should be supplemented with mappings that are specific +# to the way that the enterprise fee is attached to the order cycle. + module OrderManagement module Reports module EnterpriseFeeSummary