CL_CRM_MKTPL_EAI_READ - Common Read Class

BAL_S_LOG - Application Log: Log header data   RFUMSV00 - Advance Return for Tax on Sales/Purchases  
This documentation is copyright by SAP AG.

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

General Class Description

Common Read Class

__________________________________________________________

Class Info

Name:CL_CRM_MKTPL_EAI_READ
Instantiation:Public

Superclass

CL_CRM_MKTPL_EAI

Implemented Interfaces

None

Friend Classes

None

Subclasses

CL_CRM_MKTPL_EAI_READ_AGR
CL_CRM_MKTPL_EAI_READ_TPM

__________________________________________________________

Methods

CHECK_IS_PARTIAL_PROJECT

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_IS_TARGET_GROUP_PROJECT

Protected ABAP_BOOL CHECK_IS_TARGET_GROUP_PROJECT(

IMPORTINGANY IS_MKTPROJ_ATTRIBUTES

)

Raises a warning message if the promotion contains a target group.
Marketing projects with a target group are currently not supported by the READ service.

Returns

ing RV_HAS_TARGET_GROUP A value indicating whether this promotion has a target group or not.

Parameters

- IS_MKTPROJ_ATTRIBUTESAttributes of the marketing project to verify for a target group.

________________________________________________________________________

READ

Public READ(

IMPORTINGCRMT_MKTPL_EAI_EXTID IT_EXTERNAL_ID
EXPORTINGSTANDARD TABLE ET_MARKETING_PROJECTS
CRMT_MKTPL_EAI_LOG ET_MESSAGE_LOG

)

This method is responsible for reading reading multiple marketing objects in series.

Parameters

- IT_EXTERNAL_IDTable of marketing project IDs.
- ET_MARKETING_PROJECTSA table containing the marketing projects.
- ET_MESSAGE_LOGTable of messages raised during the read operation.

________________________________________________________________________

READ_ASSIGNMENT_BLOCKS

Protected Abstract READ_ASSIGNMENT_BLOCKS(

IMPORTINGCRM_MKTGS_GUID IV_MKTPROJ_GUID
CHANGINGANY CS_MARKETING_PROJECT

)

________________________________________________________________________

READ_ATTACHMENTS

Protected READ_ATTACHMENTS(

IMPORTINGCRM_MKTGS_GUID IV_MKTPROJ_GUID
EXPORTINGCRMT_MKTPL_EAI_ATTACHMENTS ET_ATTACHMENTS

)

This method will take care of reading files and urls (attachments) from the marketing project.

Parameters

- IV_MKTPROJ_GUIDMarketing Project Guid
- ET_ATTACHMENTSA table of attachment attributes

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDAssignment read failed

________________________________________________________________________

READ_ATTRIBUTES

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_MARKETING_PROJECT_HEADER

Public READ_MARKETING_PROJECT_HEADER(

IMPORTINGCRM_MKTGS_GUID IV_MKTPROJ_GUID
CRM_MKTGS_EXTID IV_MKTPROJ_EXTERNAL_ID
EXPORTINGCGPL_T_TEXTS ET_MKTPROJ_DESCRIPTIONS
CRM_MKTPL_MKTELEMENT ES_ATTRIBUTES

)

This method is responsible for reading a marketing project. You can read it by specifying a guid
or an external ID.

Parameters

- IV_MKTPROJ_GUID(Optional) The marketing project guid to read.
- IV_MKTPROJ_EXTERNAL_ID(Optional) The marketing project external ID to read.
- ET_MKTPROJ_DESCRIPTIONSA table containing the texts of additional descriptions pertaining to the marketing project.
- ES_ATTRIBUTESThe marketing project attributes

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised when the marketing project could not be read.

________________________________________________________________________

READ_NOTES

Protected READ_NOTES(

IMPORTINGCRM_MKTGS_GUID IV_MKTPROJ_GUID
EXPORTINGCRMT_MKTPL_EAI_NOTE ET_NOTES

)

This method is responsible for reading notes from the marketing project

Parameters

- IV_MKTPROJ_GUIDMarketing project guid
- ET_NOTESTable of notes

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised when the read of notes fails

________________________________________________________________________

READ_PARTNERS

Protected READ_PARTNERS(

IMPORTINGCGPL_GUID16 IV_MKTPROJ_GUID
EXPORTINGCRMT_MKTPL_PARTNER ET_PARTNERS

)

This method is responsible for reading partners from the marketing project by using the appropriate appl_base method

Parameters

- IV_MKTPROJ_GUID: Marketing project guid
- ET_PARTNERS: A table of partners.

Exceptions

- CX_CRM_MKTPL_EAI_FAILED: Failed to read partner assignment

________________________________________________________________________

READ_PRODUCTS

Protected READ_PRODUCTS(

IMPORTINGCGPL_GUID16 IV_MKTPROJ_GUID
EXPORTINGANY TABLE ET_PRODUCTS

)

This method is responsible for reading products from the marketing project.

Parameters

- IV_MKTPROJ_GUIDMarketing project guid.
- ET_PRODUCTSA table of products.

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised when the read of products fails.

________________________________________________________________________

READ_PRODUCT_CATEGORIES

Protected READ_PRODUCT_CATEGORIES(

IMPORTINGCGPL_GUID16 IV_MKTPROJ_GUID
EXPORTINGANY TABLE ET_PRODUCT_CATEGORIES

)

This method is responsible for reading product categories from a marketing project.

Parameters

- IV_MKTPROJ_GUIDMarketing project guid
- ET_PRODUCT_CATEGORIESA table of product categories.

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised when the read of product categories fails.

________________________________________________________________________

READ_PRODUCT_GROUPS

Protected READ_PRODUCT_GROUPS(

IMPORTINGCGPL_GUID16 IV_MKTPROJ_GUID
EXPORTINGANY TABLE ET_PRODUCT_GROUPS

)

This method is responsible for reading product groups from a marketing project.

Parameters

- IV_MKTPROJ_GUIDMarketing project guid.
- ET_PRODUCT_GROUPSA table of product groups.

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised when the read of prodcut groups fails.

________________________________________________________________________

READ_SINGLE

Protected READ_SINGLE(

IMPORTINGCRMT_MKTPL_EXTID IV_EXTERNAL_ID
EXPORTINGANY ES_MARKETING_PROJECT

)

This method is reponsible for reading all the assignment blocks of the marketing project.

Parameters

- IV_EXTERNAL_IDMarketing project external ID to read.
- ES_MARKETING_PROJECTMarleting Project data corresponding to IV_EXTERNAL_ID.

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDWe only propagate any exception that might occur.

________________________________________________________________________

READ_SYSTEM_STATUSES

Protected READ_SYSTEM_STATUSES(

IMPORTINGCGPL_GUID16 IV_MKTPROJ_GUID
EXPORTINGCRMT_MKTPL_EAI_SYS_STATUS ET_SYSTEM_STATUSES

)

This method is responsible for reading the current system statuses of the marketing project.

Parameters

- IV_MKTPROJ_GUIDMarketing project Guid.
- ET_SYSTEM_STATUSESA table of current system statuses of the marketing object.

Exceptions

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

________________________________________________________________________

READ_USER_STATUSES

Protected READ_USER_STATUSES(

IMPORTINGCGPL_GUID16 IV_MKTPROJ_GUID
EXPORTINGJ_STSMA EV_STATUS_PROFILE
CRMT_MKTPL_EAI_USER_STATUS ET_USER_STATUSES

)

This method is responsible for reading the current user statuses of the marketing project.

Parameters

- IV_MKTPROJ_GUIDMarketing project Guid.
- EV_STATUS_PROFILEStatus profile associated to the user statuses (set in the customizing).
- ET_USER_STATUSESA table of current user statuses of the marketing object.

Exceptions

- CX_CRM_MKTPL_EAI_FAILEDRaised if either the user statuses could not be retrieved
 due to an erroneous marketing project guid.



Fill RESBD Structure from EBP Component Structure   General Material Data  
This documentation is copyright by SAP AG.


Length: 24304 Date: 20120526 Time: 113331     triton ( 124 ms )