CL_CRM_MKTHV_SMM_EXECUTION - Execution

RFUMSV00 - Advance Return for Tax on Sales/Purchases   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

Represents a mass mail execution. Depending on the execution's state,the packages of the execution
are send to the SAP mass mailer instances.
The flag package_complete indicates, that all packages are delivered completely. As soon as the first package
is availabe, the SAP mass mailer infrastructure can start sending themails to the SMTP landscape. If all packages
are provided, the flag package_complete should be set to true, in order to set the execution to completed.

__________________________________________________________

Class Info

Name:	CL_CRM_MKTHV_SMM_EXECUTION
Instantiation:	Public

Superclass

None

Implemented Interfaces

None

Friend Classes

None

Subclasses

None

__________________________________________________________

Methods

ACTIVATE

Public ACTIVATE( )

Activates an execution. Writes message in application log

________________________________________________________________________

ARE_PACKAGES_COMPLETE

Public CRM_MKTHV_SMM_PACKAGE_COMPLETE ARE_PACKAGES_COMPLETE( )

Checks if all packages are already provided.

________________________________________________________________________

COMPLETE

Public CRMT_BOOLEAN COMPLETE(

IMPORTING

CRMT_BOOLEAN

IV_CHECK

)

Sets execution to completed. Writes summary messages in application log

Returns

RV_SUCCESS Returns if completed could be set successfully

Parameters

-	IV_CHECK	If parameter is set to true, it is checked if all packages of the execution are
	completed and if all packages are already provided. If parameter is set to false, the execution
	is completed without check

________________________________________________________________________

CONSTRUCTOR

Public CONSTRUCTOR(

IMPORTING	CRMS_MKTHV_SMM_EXECUTION	IS_EXECUTION
CRMT_MKTHV_SMM_PROPERTY	IT_PROPERTIES

)

Constructor

Parameters

-	IS_EXECUTION	Internal execution structure
-	IT_PROPERTIES	Execution properties if available

________________________________________________________________________

DEACTIVATE

Public DEACTIVATE( )

Deactivates an execution. Writes message in application log

________________________________________________________________________

DELETE

Public DELETE( )

Deletes an execution including its packages and properties

________________________________________________________________________

ERROR

Public ERROR( )

Sets an execution to error. Writes message in application log

________________________________________________________________________

GET_EXECUTION_GUID

Public CRM_MKTHV_SMM_GUID GET_EXECUTION_GUID( )

Returns execution guid

________________________________________________________________________

GET_EXECUTION_ID

Public STRING GET_EXECUTION_ID( )

Returns execution ID

________________________________________________________________________

GET_EXECUTION_NUMBER

Public CRM_MKTHV_SMM_EXECUTION_NUMBER GET_EXECUTION_NUMBER( )

Returns execution number

________________________________________________________________________

GET_LOG_HANDLE

Public BALLOGHNDL GET_LOG_HANDLE( )

Returns log handle

________________________________________________________________________

GET_MESSAGES

Public CL_CRM_MKTHV_SMM_MESSAGES GET_MESSAGES( )

Returns message object for execution. If log handle was not provided as
execution was created a new log handle is created

________________________________________________________________________

GET_PACKAGES

Public CL_CRM_MKTHV_SMM_PACKAGES GET_PACKAGES( )

Returns packages

________________________________________________________________________

GET_PACKAGE_TABLE

Public CRMT_MKTHV_SMM_PACKAGE GET_PACKAGE_TABLE()

Returns packages in table format

________________________________________________________________________

GET_PRIORITY

Public CRM_MKTHV_SMM_PRIORITY GET_PRIORITY( )

Returns priority

________________________________________________________________________

GET_PROJECT_GUID

Public CRM_MKTHV_SMM_GUID GET_PROJECT_GUID( )

Returns project GUID

________________________________________________________________________

GET_PROJECT_ID

Public CRM_MKTHV_SMM_PROJECT_ID GET_PROJECT_ID( )

Returns project ID

________________________________________________________________________

GET_PROPERTIES

Public CL_CRM_MKTHV_SMM_PROPERTIES GET_PROPERTIES( )

Returns execution properties

________________________________________________________________________

GET_RESULT

Public GET_RESULT(

EXPORTING	I	EV_SUCCESSFULL_OUTBOUNDS
I	EV_REJECTED_OUTBOUNDS
I	EV_COMPLETED_PACKAGES
I	EV_ALL_PACKAGES
I	EV_ACCEPTED_OUTBOUNDS

)

Returns execution result
- All packages
- Completed packages
- Successfull outbounds
- Accepted outbounds
- Rejected outbounds

________________________________________________________________________

IS_COMPLETE

Public CRMT_BOOLEAN IS_COMPLETE( )

Return if execution is completed

________________________________________________________________________

IS_LOCKED

Public CRMT_BOOLEAN IS_LOCKED( )

Returns if execution is locked

________________________________________________________________________

LOCK

Public LOCK(

IMPORTING

DDENQWAIT

WAIT

)

Locks an execution

________________________________________________________________________

PRIO_DECREASE

Public CRM_MKTHV_SMM_PRIORITY PRIO_DECREASE( )

Decreases priority

________________________________________________________________________

PRIO_INCREASE

Public CRM_MKTHV_SMM_PRIORITY PRIO_INCREASE( )

Increases priority

________________________________________________________________________

SAVE

Public SAVE( )

Saves an execution and it's properties. Tries to lock object before save.
If lock is not successfull an exception is thrown

________________________________________________________________________

SET_PACKAGES_COMPLETE

Public CRM_MKTHV_SMM_PACKAGE_COMPLETE SET_PACKAGES_COMPLETE(

IMPORTING

CRM_MKTHV_SMM_PACKAGE_COMPLETE

IV_PACKAGE_COMPLETE

)

Set packages complete flag. Return old value

________________________________________________________________________

UNLOCK

Public UNLOCK(

IMPORTING

DDENQSYNC

IV_SYNCHRON

)

Unlock execution object

Fill RESBD Structure from EBP Component Structure   CL_GUI_FRONTEND_SERVICES - Frontend Services  
This documentation is copyright by SAP AG.


Length: 13127 Date: 20120526 Time: 111708     triton ( 269 ms )