SAP ABAP Class CL_EPM_HELPER (EPM: Helper class for convenience methods)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-NWD (Application Component) NetWeaver Demonstration
     ⤷ S_EPM_COMMON (Package) EPM Common Objects

Properties

Class	CL_EPM_HELPER
Short Description	EPM: Helper class for convenience methods
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_EPM_COMMON	EPM Common Objects
Created	20081217	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	IF_EPM_BO	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_EPM_HELPER has no interface implemented.

Friends

Class CL_EPM_HELPER has no friend class.

Attributes

Class CL_EPM_HELPER has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ASSIGN_USER_ROLES	Static method	Protected	Method	checks and assignes EPM profiles to user	20110308
2	CHECK_CURRENCY	Static method	Public	Method	Check Currency	20090515
3	CHECK_USER_AUTHORISATIONS	Static method	Protected	Method	checks and assignes EPM profiles to user	20110217
4	GET_ADMIN_INFO	Static method	Public	Method	Helper routine to fill admin info	20090116
5	GET_BP_ADMIN_INFO	Static method	Public	Method	Helper routine to fill admin info	20091020
6	GET_BP_GUID	Static method	Public	Method	Get the employee GUID from database	20091020
7	GET_EMPLOYEE_GUID	Static method	Public	Method	Get the employee GUID from database	20090119
8	GET_EPM_ROLES	Static method	Protected	Method	supplies the list of EPM relevant roles	20110201
9	GET_GUID	Static method	Public	Method	Get a GUID	20081217
10	GET_ID	Static method	Public	Method	Get a number from the SEPM Number Range	20081217
11	GET_RANDOM	Static method	Public	Method	Get random number from indicated interval	20090112
12	GET_SUBPACKAGES	Static method	Public	Method	Get ABAP subpackages for the specified ABAP package	20110511
13	SEND_MAIL	Static method	Public	Method	Convenience method to send e-mail	20120926

Events

Class CL_EPM_HELPER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_ABAP_DEVCLASSES	Public	See coding			20110511	tt_abap_devclasses TYPE STANDARD TABLE OF devclass WITH DEFAULT KEY
2	TT_BAPIAGR	Public	See coding			20110921	TT_BAPIAGR type STANDARD TABLE OF BAPIAGR WITH DEFAULT KEY
3	TT_BAPIPROF	Public	See coding			20110921	TT_BAPIPROF type STANDARD TABLE OF BAPIPROF WITH DEFAULT KEY
4	TT_ROLES	Public	See coding			20110308	TT_ROLES type STANDARD TABLE OF AGR_NAME

Method Signatures

Method ASSIGN_USER_ROLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20110308
2	Importing	IT_ROLES	Call by reference	☐	Type reference (TYPE)	TT_ROLES			20110308
3	Importing	IV_UNAME	Call by reference	☐	Type reference (TYPE)	XUBNAME	SY-UNAME	User Name in User Master Record	20110308

Method ASSIGN_USER_ROLES on class CL_EPM_HELPER has no exception.

Method CHECK_CURRENCY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURRCODE	Call by reference	☐	Type reference (TYPE)	SNWD_CURR_CODE		EPM: Currency Code	20090515
2	Returning	RV_CURR_OK	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090515

Method CHECK_CURRENCY on class CL_EPM_HELPER has no exception.

Method CHECK_USER_AUTHORISATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20110217
2	Importing	IT_EXSPECTED_ROLES	Call by reference	☐	Type reference (TYPE)	TT_BAPIAGR		Tabellentyp: BAPIAGR	20110217
3	Importing	IV_UNAME	Call by reference	☐	Type reference (TYPE)	XUBNAME	SY-UNAME	User Name in User Master Record	20110217

Method CHECK_USER_AUTHORISATIONS on class CL_EPM_HELPER has no exception.

Method GET_ADMIN_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ES_ADMIN_INFO	Call by reference	☐	Type reference (TYPE)	SNWD_ADMIN_DATA		EPM: Include-Structure for various tables	20090116
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20090116
3	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	SYDATUM	SY-DATLO	Current Date of Application Server	20090402
4	Importing	IV_TIME	Call by reference	☐	Type reference (TYPE)	SYUZEIT	SY-TIMLO	Current Time of Application Server	20090402
5	Importing	IV_USERNAME	Call by reference	☐	Type reference (TYPE)	SY-UNAME	SY-UNAME	User Name	20090126

Method GET_ADMIN_INFO on class CL_EPM_HELPER has no exception.

Method GET_BP_ADMIN_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ES_ADMIN_INFO	Call by reference	☐	Type reference (TYPE)	SNWD_ADMIN_DATA		EPM: Include-Structure for various tables	20091020
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20091020
3	Importing	IV_BP_ID	Call by reference	☐	Type reference (TYPE)	SNWD_PARTNER_ID		Business Partner ID	20091020
4	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	SYDATUM	SY-DATLO	Current Date of Application Server	20091020
5	Importing	IV_TIME	Call by reference	☐	Type reference (TYPE)	SYUZEIT	SY-TIMLO	Current Time of Application Server	20091020

Method GET_BP_ADMIN_INFO on class CL_EPM_HELPER has no exception.

Method GET_BP_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BP_ID	Call by reference	☐	Type reference (TYPE)	SNWD_PARTNER_ID		Business Partner ID	20091020
2	Returning	RV_GUID	Value transfer	☐	Type reference (TYPE)	SNWD_NODE_KEY		EPM: Generic Node Key	20091020

Method GET_BP_GUID on class CL_EPM_HELPER has no exception.

Method GET_EMPLOYEE_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EMPLOYEE_NAME	Call by reference	☐	Type reference (TYPE)	SYUNAME	SY-UNAME	User Name	20090119
2	Returning	RV_GUID	Value transfer	☐	Type reference (TYPE)	SNWD_NODE_KEY		EPM: Generic Node Key	20090119

Method GET_EMPLOYEE_GUID on class CL_EPM_HELPER has no exception.

Method GET_EPM_ROLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_ROLES	Value transfer	☐	Type reference (TYPE)	TT_BAPIAGR		Tabellentyp: BAPIAGR	20110201

Method GET_EPM_ROLES on class CL_EPM_HELPER has no exception.

Method GET_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_GUID	Value transfer	☐	Type reference (TYPE)	SNWD_NODE_KEY			20090119

#	Exception	Resumable	Description	Created on
1	CX_EPM_SYSTEM_EXCEPTION	☐	EPM: System exception class	20081217

Method GET_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NRNR	Call by reference	☐	Type reference (TYPE)	NRNR		Number Range Number	20081217
2	Returning	RV_ID	Value transfer	☐	Type reference (TYPE)	CHAR10		10 digit number	20090119

Method GET_ID on class CL_EPM_HELPER has no exception.

Method GET_RANDOM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOWER	Call by reference	☐	Type reference (TYPE)	I	1		20090112
2	Importing	IV_UPPER	Call by reference	☐	Type reference (TYPE)	I			20090112
3	Returning	RV_RANDOM	Value transfer	☐	Type reference (TYPE)	I			20090120

Method GET_RANDOM on class CL_EPM_HELPER has no exception.

Method GET_SUBPACKAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ET_SUBPACKAGES	Call by reference	☐	Type reference (TYPE)	TT_ABAP_DEVCLASSES		The set of subpackages	20110511
2	Importing	IV_DEVCLASS	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Get subpackages for this package	20110511

#	Exception	Resumable	Description	Created on
1	CX	☐		20110511

Method SEND_MAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RECIPIENT_ADDRESSES	Call by reference	☐	Type reference (TYPE)	STRINGTAB			20120927
2	Importing	IV_ATTACHMENT	Call by reference	☑	Type reference (TYPE)	XSTRING			20120926
3	Importing	IV_ATTACHMENT_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20120927
4	Importing	IV_ATTACHMENT_TYPE	Call by reference	☑	Type reference (TYPE)	SO_OBJ_TP		Code for document class	20120926
5	Importing	IV_EMAIL_BODY	Call by reference	☐	Type reference (TYPE)	STRING			20120926
6	Importing	IV_SENDER	Call by reference	☑	Type reference (TYPE)	SNWD_EMPLOYEES-LOGIN_NAME			20120927
7	Importing	IV_SEND_AS_HTML	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120926
8	Importing	IV_SUBJECT	Call by reference	☐	Type reference (TYPE)	STRING			20120926
9	Importing	IV_SUPPRESS_COMMIT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120927

#	Exception	Resumable	Description	Created on
1	CX_EPM_API_EXCEPTION	☐	EPM: API exception class	20120927

History

Last changed by/on	SAP	20130531
SAP Release Created in	720