CL_CRM_MKTGS_APPLICATION_MGR - MKTGS OL: Generic Marketing Application Manager

rdisp/max_wprun_time - Maximum work process run time   TXBHW - Original Tax Base Amount in Local Currency  
This documentation is copyright by SAP AG.

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

General Class Description

The application manager class is the anchor class for each application
which is based on the marketing generic object layer.
It contains
- the transactional handling of the application
- the message handler
- the collections to all business objects of the application

__________________________________________________________

Class Info

Name:	CL_CRM_MKTGS_APPLICATION_MGR
Instantiation:	Public

Superclass

None

Implemented Interfaces

None

Friend Classes

CL_CRM_MKTPL_ASG_HANDLER_PERS

Subclasses

CL_CRM_ACCPL_APPLICATION_MGR
CL_CRM_MKTPL_APPLICATION_MGR
CL_CRM_MKTPPG_APPLICATION_MGR

__________________________________________________________

Methods

AFTER_COMMIT

Public AFTER_COMMIT(

IMPORTING	ABAP_BOOL	IV_SHOW_SAVE_MESSAGE
ABAP_BOOL	IV_BW_SYNCHRONOUS
EXPORTING	ABAP_BOOL	EV_BW_DETAILED_MSG_EXIST
ABAP_BOOL	EV_BW_MD_UPD_FAILED
SYSUBRC	EV_BW_SUBRC

)

This method triggers all the processes which are performed when the changes
has successfully be written to the database
This is in detail:
- notify the ACE about change objects
- notify the enterprise search about changed objects
- the BI system is updated
- the object buffers are refreshed

Parameters

-	IV_SHOW_SAVE_MESSAGE	If true, the 'save successful' message is written into the message log
-	IV_BW_SYNCHRONOUS	If true, the BI data is written synchronously (default: true)
-	EV_BW_DETAILED_MSG_EXIST	Is set to true, if detailed error messages exist
-	EV_BW_MD_UPD_FAILED	Is set to true, if theBI master data update has been failed
-	EV_BW_SUBRC	Contains the status of the BW update

________________________________________________________________________

AFTER_ROLLBACK

Public AFTER_ROLLBACK( )

This method is performed if the save has been failed and the database changes has been rolled back
Here, the KPI changes are reset

________________________________________________________________________

CHECK_BEFORE_SAVE

Public CHAR1 CHECK_BEFORE_SAVE(

IMPORTING	ABAP_BOOL	IV_SHOW_MESSAGE
ABAP_BOOL	IV_CLEAR_MESSAGES

)

Controls the execution of the checks before the SAVE occurs.
1. Performs the post-processing logic before save (FINALIZE_BEFORE_SAVE)
2. Performs the CHECK logic (DO_CHECK_BEFORE_SAVE)
3. Log the final error message in case an error has been found

Returns

Failed flag which is true, if at least one object contains errors

Parameters

-	IV_SHOW_MESSAGE	If true, an error message is shown if the check fails
-	IV_CLEAR_MESSAGES	If true, the message loghas to be cleared

________________________________________________________________________

CHECK_FOR_CHANGES

Public ABAP_BOOL CHECK_FOR_CHANGES( )

This method checks if any object has been changed in the application

Returns

True, if changes exist

________________________________________________________________________

COMMIT

Public ABAP_BOOL COMMIT( )

This method triggers all DB update tasks which are in the update buffer.
If these can be successfully processed, all changes are written to the database
NOTE: This method is not called when using the CRM WebUI, as the UI framework
has its own commit handling. This commit method is only relevant outside
the CRM WebUI, such as when using local reports, batch jobs, etc.

Returns

Failed flag which is true, if one of the DB update task has failed.
In this case, no data has been written to the database

________________________________________________________________________

CONSTRUCTOR

Public CONSTRUCTOR( )

This is the constructor.

________________________________________________________________________

CREATE_MAIN_COLLECTIONS

Protected CREATE_MAIN_COLLECTIONS( )

This is the constructor.

________________________________________________________________________

DO_CHECK_BEFORE_SAVE

Public CHAR1 DO_CHECK_BEFORE_SAVE(

IMPORTING

ABAP_BOOL

IV_SHOW_MESSAGE

)

This checks whether all objects are in a consistent state and can besaved

Returns

Failed flag which is true, if at least one object contains errors

Parameters

-

IV_SHOW_MESSAGE

If true, an error message is shown if the check fails

________________________________________________________________________

DO_CLEANUP

Public DO_CLEANUP( )

This method cleans up the application buffer and all related buffers

________________________________________________________________________

DO_SAVE

Public CHAR1 DO_SAVE( )

This method writes all changes of the object buffer into DB update tasks

Returns

Failed flag which is true, if one step of the save process has failed

________________________________________________________________________

FINALIZE_BEFORE_SAVE

Protected FINALIZE_BEFORE_SAVE( )

This method does necessary finalization right before the save
Here, the KPI data is synchronized

________________________________________________________________________

GET_BADI_MANAGER

Public CL_CRM_MKTGS_OL_BADI_MANAGER GET_BADI_MANAGER( )

This method returns the default BAdI manager which calls no BAdI
To be redefined by the specific application in case a BAdI should be connected

Returns

BAdI interface reference

________________________________________________________________________

GET_COLLECTION_FOR_TYPE

Public CL_CRM_MKTGS_MAIN_COLLECTIONGET_COLLECTION_FOR_TYPE(

IMPORTING

CRM_MKTGS_OBJECT_TYPE

IV_OBJECT_TYPE

)

This method returns the default BAdI manager which calls no BAdI
To be redefined by the specific application in case a BAdI should be connected

Returns

BAdI interface reference

________________________________________________________________________

GET_EVENT_MANAGER

Public CL_CRM_MKTGS_OL_EVENT_MANAGER GET_EVENT_MANAGER( )

This method returns the event manager reference

Returns

Event manager reference

________________________________________________________________________

GET_INSTANCE_FOR_TYPE

Public staticCL_CRM_MKTGS_APPLICATION_MGR GET_INSTANCE_FOR_TYPE(

IMPORTING

CRM_MKTGS_APPLICATION_TYPE

IV_APPLICATION_TYPE

)

This method returns the application manager reference

Returns

Application manager reference

Parameters

-

IV_APPLICATION_TYPE

Contains the requestedapplication type

________________________________________________________________________

GET_MESSAGES_FROM_BAPI_EX

Protected GET_MESSAGES_FROM_BAPI_EX(

IMPORTING

CX_BAPI_EXCEPTION

IR_BAPI_EXCEPTION

)

Get BAPI exception messages and puts them into the message log

________________________________________________________________________

GET_MESSAGE_HANDLER

Public CL_CRM_MKTGS_MSG_HANDLER GET_MESSAGE_HANDLER( )

This method returns the message handler reference

Returns

Message handler reference

________________________________________________________________________

GET_MODIFIED_OBJECTS

Public GET_MODIFIED_OBJECTS(

IMPORTING	CRMT_MKTGS_OBJECT_STATE	IT_REQUESTED_OBJECT_STATE
EXPORTING	CRMT_MKTGS_OBJ_ITEM_INFO	ET_MODIFIED_OBJECT_INFO
CL_CRM_MKTGS_GEN_COLLECTION	ER_MODIFIED_OBJECTS

)

This method collects the requested modified object information

Parameters

-	IT_REQUESTED_OBJECT_STATE	Table of requested object states (optional) - all modified object states are taken into account if not supported
-	ET_MODIFIED_OBJECT_INFO	Table of modified objects with the most important information
-	ER_MODIFIED_OBJECTS	All modified objects in a collection

________________________________________________________________________

GET_OBJECT_BY_GUID

Public CL_CRM_MKTGS_OBJ_ITEM GET_OBJECT_BY_GUID(

IMPORTING

CRM_MKTGS_GUID

IV_GUID

)

Returns the object by guid

________________________________________________________________________

GET_PROCESS_MODE

Public CRM_MKTGS_PROCESS_MODE GET_PROCESS_MODE( )

This method returns the application process mode

Returns

Current process mode
Possible values:
- Backend: CO_PROCESS_MODE_BACKEND
- Upload: CO_PROCESS_MODE_UPLOAD
- UI: CO_PROCESS_MODE_UI

________________________________________________________________________

INITIALIZE

Public INITIALIZE( )

This method initialize the application buffers

________________________________________________________________________

INIT_APPLICATION

Protected INIT_APPLICATION( )

This method contains the default application initialization:
- Initialize the cgpl application
- Set the cgpl message id
- Ensure the assignment handler persistency instance is created for cgpl event handling
- Set the cgpl user options
- Set the process mode initially to backend
- Create the message handler
- Create the event manager
- Create the main collections
- Initialize BI/BW
- Initialize SEM

________________________________________________________________________

INIT_BW

Protected INIT_BW( )

________________________________________________________________________

INIT_SEM

Protected INIT_SEM( )

________________________________________________________________________

NOTIFY_ACE

Protected NOTIFY_ACE(

IMPORTING

CRMT_MKTGS_OBJ_ITEM_INFO

IT_MODIFIED_OBJECT

)

________________________________________________________________________

NOTIFY_BOR

Protected NOTIFY_BOR(

IMPORTING

CRMT_MKTGS_OBJ_ITEM_INFO

IT_MODIFIED_OBJECT

)

________________________________________________________________________

NOTIFY_ENTERPRISE_SEARCH

Protected NOTIFY_ENTERPRISE_SEARCH(

IMPORTING

CRMT_MKTGS_OBJ_ITEM_INFO

IT_MODIFIED_OBJECT

)

________________________________________________________________________

SAVE_AND_COMMIT

Public CHAR1 SAVE_AND_COMMIT( )

This method saves all changes and executes a database commit.

Returns

Failed flag which is true, if the save has failed

________________________________________________________________________

SET_PROCESS_MODE

Public SET_PROCESS_MODE(

IMPORTING

CRM_MKTGS_PROCESS_MODE

IV_PROCESS_MODE

)

This method sets the application process mode

Parameters

-	IV_PROCESS_MODE	Sets the process mode
	Possible values:
	- Backend: CO_PROCESS_MODE_BACKEND
	- UI: CO_PROCESS_MODE_UI

________________________________________________________________________

UNLOCK

Public CHAR1 UNLOCK( )

This method removes the locks for all objects

Returns

Failed flag, which is true if at least one lock could not be removed

rdisp/max_wprun_time - Maximum work process run time   ABAP Short Reference  
This documentation is copyright by SAP AG.


Length: 21834 Date: 20120526 Time: 110622     triton ( 215 ms )