CL_CRM_MKTPL_EAI_READ_TPM - The EAI Read class for TPM

BAL_S_LOG - Application Log: Log header data   Vendor Master (General Section)  
This documentation is copyright by SAP AG.

>>> Development Documentation generated by DocuGenerator v2.0 (only available in English => NO TRANSLATION!!!) <<<

General Class Description

The EAI Read class for TPM

__________________________________________________________

Class Info

Name:CL_CRM_MKTPL_EAI_READ_TPM
Instantiation:Public

Superclass

CL_CRM_MKTPL_EAI_READ

Implemented Interfaces

None

Friend Classes

None

Subclasses

None

__________________________________________________________

Methods

CHECK_HAS_PCAT_EFF_DATES

Private CHECK_HAS_PCAT_EFF_DATES(

IMPORTINGCRMT_MKTPL_EAI_TPM_PCAT IT_PRODUCT_CATEGORIES

)

This method is reponsible for checking whether any of the incoming product categories have effective dates

Parameters

- IT_PRODUCT_CATEGORIES: Table of Product Categories

________________________________________________________________________

CHECK_HAS_PGRP_EFF_DATES

Private CHECK_HAS_PGRP_EFF_DATES(

IMPORTINGCRMT_MKTPL_EAI_TPM_PGRP IT_PRODUCT_GROUPS

)

This method is reponsible for checking whether any of the incoming product groups have effective dates

Parameters

- IT_PRODUCT_GROUPS: Table of Product Groups

________________________________________________________________________

CHECK_HAS_PROD_EFF_DATES

Private CHECK_HAS_PROD_EFF_DATES(

IMPORTINGCRMT_MKTPL_EAI_TPM_PRODUCTS IT_PRODUCTS

)

This method is reponsible for checking whether any of the incoming products have effective dates

Parameters

- IT_PRODUCTS: Table of Products

________________________________________________________________________

CHECK_IS_DISPLAY_PALLET_TPM

Private ABAP_BOOL CHECK_IS_DISPLAY_PALLET_TPM(

IMPORTINGCRMS_MKTPL_EAI_HEADER_TPM_ATTR IS_TRADE_PROMOTION_ATTRIBUTES

)

This method is reponsible for checking whether the incoming trade promotion
attributes indicate that the trade promotion is a display pallet promotion

Returns

ing RV_IS_DISPLAY_PALLET_PROMO A value indicating whether this is promotion is of the type display pallet.

Parameters

- IS_TRADE_PROMOTION_ATTRIBUTES: Trade Promotion attributes

________________________________________________________________________

CHECK_IS_PARTIAL_PROJECT

Redefined Protected ABAP_BOOL CHECK_IS_PARTIAL_PROJECT(

IMPORTINGANY IS_MARKETING_PROJECT

)

Checks if there are unsupported attributes by the READ service.
If an unsupported attribute is found, we raise a warning to report it.

Returns

ing RV_IS_PARTIAL A value indicating whether this is a partial project or not.

Parameters

- IS_MARKETING_PROJECTStructuce of the marketing project to check (includes all assignment blocks).

________________________________________________________________________

CHECK_PRODUCT_SEGMENT_EXISTS

Private ABAP_BOOL CHECK_PRODUCT_SEGMENT_EXISTS(

IMPORTINGCRMS_MKTPL_EAI_HEADER_TPM_ATTR IS_TRADE_PROMOTION_ATTRIBUTES

)

This method is reponsible for checking whether the incoming trade promotion
attributes indicate that the trade promotion contains product segments

________________________________________________________________________

MAP_DATA_PRODUCTS

Private MAP_DATA_PRODUCTS(

IMPORTINGCRMT_MKTPL_KPI_PLAN_DATA IT_KPI_PLAN_DATA
CHANGINGCRMT_MKTPL_EAI_TPM_PRODUCTS CT_EAI_PRODUCTS

)

This method maps all the keyfigures related to products to the product structure
in the keyfigure name / value pair format within the keyfigure table.

Parameters

- IT_KPI_PLAN_DATAAll planning data retrieved from promotion
- CT_EAI_PRODUCTSTable of products to which keyfigure information will be imbedded

________________________________________________________________________

MAP_DATA_PRODUCT_CATEGORIES

Private MAP_DATA_PRODUCT_CATEGORIES(

IMPORTINGCRMT_MKTPL_KPI_PLAN_DATA IT_KPI_PLAN_DATA
CHANGINGCRMT_MKTPL_EAI_TPM_PCAT CT_EAI_PRODUCT_CATEGORIES

)

This method maps all the keyfigures related to products to the product structure
in the keyfigure name / value pair format within the keyfigure table.

Parameters

- IT_KPI_PLAN_DATAAll planning data retrieved from promotion
- CT_EAI_PRODUCT_CATEGORIESTable of product categories to which keyfigure information will be imbedded

________________________________________________________________________

MAP_DATA_PRODUCT_GROUPS

Private MAP_DATA_PRODUCT_GROUPS(

IMPORTINGCRMT_MKTPL_KPI_PLAN_DATA IT_KPI_PLAN_DATA
CHANGINGCRMT_MKTPL_EAI_TPM_PGRP CT_EAI_PRODUCT_GROUPS

)

This method maps all the keyfigures related to product groups to the product group structure
in the keyfigure name / value pair format within the keyfigure table.

Parameters

- IT_KPI_PLAN_DATAAll planning data retrieved from promotion
- CT_EAI_PRODUCT_GROUPSTable of product groups to which keyfigure information will be imbedded

________________________________________________________________________

MAP_PLANNING_DATA

Private MAP_PLANNING_DATA(

IMPORTINGCRM_MKTGS_GUID IV_MKTPROJ_GUID
CHANGINGCRMS_MKTPL_EAI_TPM CS_TPM_EAI_ATTRIBUTES

)

This method is responsible for reading all keyfigures
into the keyfigure name / value pair format for each product dimension.
It first checks if there is planning data. The conditions to have planning data are:
- there should be a planning profile group
- there should be at least one product, product category or product group
- there should be buying dates.

Parameters

- IV_MKTPROJ_GUID: Trade Promotion guid
- CS_TPM_EAI_ATTRIBUTES: Trade Promotion attribute structure

Exceptions

- CX_CRM_MKTPL_EAI_FAILED: Raised when BI Data is not retrieved

________________________________________________________________________

READ_AGREEMENT_ID

Private CGPL_EXTID READ_AGREEMENT_ID(

IMPORTINGCGPL_GUID16 IV_TRADE_PROMOTION_GUID

)

This method is responsible for reading the agreement id assigned to a given trade promotion.

Returns

RV_AGREEMENT_ID The external ID of the agreement.

Parameters

- IV_TRADE_PROMOTION_GUIDTrade promotion guid.

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised if the agreement id could not be retrieved
 due to an erroneous marketing project guid.

________________________________________________________________________

READ_ASSIGNMENT_BLOCKS

Redefined Protected READ_ASSIGNMENT_BLOCKS(

IMPORTINGCRM_MKTGS_GUID IV_MKTPROJ_GUID
CHANGINGANY CS_MARKETING_PROJECT

)

Reads all the assignment blocks of a marketing project.

Parameters

- IV_MKTPROJ_GUIDGuid of the marketing project to read.
- CS_MARKETING_PROJECTStructure where we need to put the result of the read for
 each assignment block.

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDPropagate any exception that occurred in the read process
 of any assignment block.

________________________________________________________________________

READ_ATTRIBUTES

Redefined Protected READ_ATTRIBUTES(

IMPORTINGCRM_MKTGS_EXTID IV_MARKETING_PROJECT_ID
EXPORTINGANY ES_ATTRIBUTES

)

Reads the attributes of a marketing project.

Parameters

- IV_MARKETING_PROJECT_IDExternal ID of the marketing project to read.
- ES_ATTRIBUTESAttributes of the marketing_project.

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDWe only propagate any exception that might occur.

________________________________________________________________________

READ_CAUSALS

Private READ_CAUSALS(

IMPORTINGCGPL_GUID16 IV_TRADE_PROMOTION_GUID
EXPORTINGCRMT_MKTPL_CAU ET_CAUSALS

)

This method is responsible for reading causals from a marketing project.

Parameters

- IV_TRADE_PROMOTION_GUIDThe marketing project guid.
- ET_CAUSALSA table of causals.

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised when the read of causals fails.

________________________________________________________________________

READ_CAUSAL_TRADE_SPENDS

Private READ_CAUSAL_TRADE_SPENDS(

IMPORTINGCRM_MKTGS_GUID IV_TRADE_PROMOTION_GUID
CRMT_MKTPL_CAU IT_CAUSALS
EXPORTINGCRMT_MKTPL_EAI_CAU_TSP ET_CAUSAL_TRADE_SPENDS

)

This method is responsible for returning all the causal trade spends that are in this trade promotion

Parameters

- IV_TRADE_PROMOTION_GUIDThe trade promotion guid.
- IT_CAUSALSA table containing the causals assigned to the trade promotion
- ET_CAUSAL_TRADE_SPENDSA table containing the causal trade spends for the trade promotion

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised if the trade spends assigned to a causal could not be retrieved.

________________________________________________________________________

READ_DATE_RANGES

Private READ_DATE_RANGES(

IMPORTINGCGPL_GUID16 IV_TRADE_PROMOTION_GUID
EXPORTINGCRMT_MKTPL_EAI_DATES ET_DATE_RANGES

)

This method is responsible for reading the appropriate date ranges from a trade promotion

Parameters

- IV_TRADE_PROMOTION_GUIDMarketing Project Guid
- ET_DATE_RANGESTable of date ranges

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised when the read of dates assigned to the promotion fails

________________________________________________________________________

READ_FUNDS_PLAN_ID

Private CRM_FM_FND_FUNDPLAN_ID READ_FUNDS_PLAN_ID(

IMPORTINGCGPL_GUID16 IV_TRADE_PROMOTION_GUID

)

This method is responsible for reading the funds plan id from a trade promotion.

Returns

RV_FUNDS_PLAN_ID Funds plan ID associated to the promotion

Parameters

- IV_TRADE_PROMOTION_GUIDThe trade promotion guid.

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised if the funds plan id could not be retrieved
 due to an erroneous marketing project guid.

________________________________________________________________________

READ_TRADESPEND_EXCEPTIONS

Public READ_TRADESPEND_EXCEPTIONS(

IMPORTINGCGPL_GUID16 IV_TRADE_PROMOION_GUID
CGPL_GUID16 IV_TRADESPEND_GUID
EXPORTINGCRMT_MKTGS_TSPEX ET_TRADESPEND_EXCEPTIONS

)

This method is responsible for reading trade spend exceptions from the trade promotion.

Parameters

- IV_TRADE_PROMOION_GUIDThe trade promotions guid.
- IV_TRADESPEND_GUIDThe Tradespend guid.
- ET_TRADESPEND_EXCEPTIONSA table of trade spends.

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised when the read of trade spend exceptions fails.

________________________________________________________________________

READ_TRADE_SPENDS

Public READ_TRADE_SPENDS(

IMPORTINGCGPL_GUID16 IV_TRADE_PROMOTION_GUID
EXPORTINGCRMT_MKTPL_EAI_TS ET_TRADE_SPENDS

)

This method is responsible for reading trade spends from the trade promotion

Parameters

- IV_TRADE_PROMOTION_GUIDTrade promotion guid.
- ET_TRADE_SPENDSA table of trade spends.

Exceptions

- CX_CRM_MKTPL_EAI_FAILED: Failed to read the trade spends from the trade promotion.



CPI1466 during Backup   rdisp/max_wprun_time - Maximum work process run time  
This documentation is copyright by SAP AG.


Length: 27140 Date: 20120526 Time: 113519     triton ( 197 ms )