SAP ABAP Class /RPM/CL_SUBSTITUTE_API (xRPM Susbstitute Provider class)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PPM-PFM (Application Component) Portfolio Management
     ⤷ /RPM/API (Package) xRPM External Interfaces

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/RPM/CL_OBJECT_API	xRPM Object Provider Super Class	20060109
2	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_DASHBOARD	Dashboard Interface	20090226
3	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_PROVIDER_ACCESS	ESA: "CRUD"-Interface Pattern	20060109
4	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_PROVIDER_ACTION	ESA: "Action"-Interface Pattern	20060109
5	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_PROVIDER_QUERY	ESA: "Query"-Interface-Pattern	20060109
6	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_PROVIDER_TRANSACTION	ESA: "Transaction"-Interface Pattern	20060109

Properties

Class	/RPM/CL_SUBSTITUTE_API
Short Description	xRPM Susbstitute Provider class
Super Class	/RPM/CL_OBJECT_API	xRPM Object Provider Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/RPM/API	xRPM External Interfaces
Created	20060109	SAP
Last change	20141109
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /RPM/CL_SUBSTITUTE_API has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	/RPM/IF_DASHBOARD	☐	☐	Dashboard Interface	20090226
2	/RPM/IF_PROVIDER_ACCESS	☐	☐	ESA: "CRUD"-Interface Pattern	20060109
3	/RPM/IF_PROVIDER_ACTION	☐	☐	ESA: "Action"-Interface Pattern	20060109
4	/RPM/IF_PROVIDER_QUERY	☐	☐	ESA: "Query"-Interface-Pattern	20060109
5	/RPM/IF_PROVIDER_TRANSACTION	☐	☐	ESA: "Transaction"-Interface Pattern	20060109

Friends

Class /RPM/CL_SUBSTITUTE_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_SUBSTITUTES	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ACO_SUBSTITUTES		Substitute Collection	20060112
2	MV_API_OBJECT_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20060113
3	MV_STRUC_NAME_ROOT	Instance attribute	Private	☐	Type reference (TYPE)	STRUKNAME		Name of a structure	20060113
4	MV_STRUC_NAME_ROOT_DATA	Instance attribute	Private	☐	Type reference (TYPE)	STRUKNAME		Name of a structure	20060113
5	MV_STRUC_NAME_ROOT_KEY	Instance attribute	Private	☐	Type reference (TYPE)	STRUKNAME		Name of a structure	20060113
6	OR_BUCKET	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/RPM/CL_BUCKET_O		Hierarchy bucket operational object	20060109
7	OR_OBJ_MANAGER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/RPM/CL_OBJ_MANAGER		RPM-Project and Portfolio Controller	20060109
8	OR_PORTFOLIO	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/RPM/CL_ENTITY_PROJECT		General object definition	20060109
9	OS_MODE	Instance attribute	Public	☐	Type reference (TYPE)	/RPM/TS_CHANGE_MODE		Object Change Mode	20060109
10	OT_GUID	Instance attribute	Public	☐	Type reference (TYPE)	/RPM/TT_GUIDS		Table of RPM guids	20060109
11	OV_LANGU	Instance attribute	Private	☐	Type reference (TYPE)	LANGU		Language Key	20060109
12	OV_NODE_DETAIL	Constant	Public	☐	Type reference (TYPE)	STRING	'DETAIL'		20060109
13	OV_QUERY_GET_OBJ_FOR_SUBST	Constant	Public	☐	Type reference (TYPE)	STRING	'GET_OBJ_FOR_SUBST'	Get Objects for substitution	20060112
14	OV_RC	Instance attribute	Public	☐	Type reference (TYPE)	I			20060109

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_SUBSTITUTE	Instance method	Private	Method	Create Substitute	20060118
2	DELETE_SUBSTITUTE	Instance method	Private	Method	Delete Substitute	20060118
3	DO_SAVE	Instance method	Public	Method		20060113
4	GET_ALL_OBJ_FOR_SUBSTITUTE	Instance method	Private	Method		20060216
5	GET_OBJ_FOR_SUBSTITUTE	Instance method	Private	Method	Get Objects for Substitution	20060112
6	UPDATE_SUBSTITUTE	Instance method	Private	Method	Update Substitute	20060118

Events

Class /RPM/CL_SUBSTITUTE_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_ACTIONS	Public	Attribute reference (LIKE)			20060109
2	TY_MODIFICATIONS	Public	Attribute reference (LIKE)			20060109

Method Signatures

Method CREATE_SUBSTITUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	IN_ACTIONS	Call by reference	☐	Type reference (TYPE)	TT_ACTIONS			20060118
2	Importing	IN_CHANGE_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_CHANGE_HANDLER			20060118
3	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20060118
4	Changing	IN_MODIFICATIONS	Call by reference	☐	Type reference (TYPE)	TT_MODIFICATIONS			20060118

Method CREATE_SUBSTITUTE on class /RPM/CL_SUBSTITUTE_API has no exception.

Method DELETE_SUBSTITUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	IN_ACTIONS	Call by reference	☐	Type reference (TYPE)	TT_ACTIONS			20060118
2	Importing	IN_CHANGE_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_CHANGE_HANDLER			20060118
3	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20060118
4	Changing	IN_MODIFICATIONS	Call by reference	☐	Type reference (TYPE)	TT_MODIFICATIONS			20060118

Method DELETE_SUBSTITUTE on class /RPM/CL_SUBSTITUTE_API has no exception.

Method DO_SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20060113
2	Exporting	OUT_REJECTED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20060113

Method DO_SAVE on class /RPM/CL_SUBSTITUTE_API has no exception.

Method GET_ALL_OBJ_FOR_SUBSTITUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OBJECTS	Call by reference	☐	Type reference (TYPE)	ACO_TT_SUBSTITUTE_OBJECT		Objects for which a substitute is to be specified	20060216
2	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	ACO_OBJECT_TYPE		Object Category	20060216
3	Importing	IV_USER_ID	Call by reference	☐	Type reference (TYPE)	ACO_USER_ID	SY-UNAME	User ID	20060216

Method GET_ALL_OBJ_FOR_SUBSTITUTE on class /RPM/CL_SUBSTITUTE_API has no exception.

Method GET_OBJ_FOR_SUBSTITUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20060112
2	Importing	IN_FILL_DATA	Call by reference	☑	Type reference (TYPE)	SCOL_BOOLEAN		Boolean	20060112
3	Importing	IN_FILTER_KEYS	Call by reference	☑	Type reference (TYPE)	INDEX TABLE			20060112
4	Importing	IN_MESSAGE_BUFFER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20060112
5	Importing	IN_QUERY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20060112
6	Importing	IN_QUERY_OPTIONS	Call by reference	☑	Type reference (TYPE)	TY_QUERY_OPTIONS			20060112
7	Importing	IN_SELECTION_PARAMETERS	Call by reference	☑	Type reference (TYPE)	TT_SELECTION_PARAMETERS			20060112
8	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20060112
9	Exporting	OUT_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20060112
10	Exporting	OUT_QUERY_INFO	Call by reference	☐	Type reference (TYPE)	TY_QUERY_INFO			20060112

Method GET_OBJ_FOR_SUBSTITUTE on class /RPM/CL_SUBSTITUTE_API has no exception.

Method UPDATE_SUBSTITUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	IN_ACTIONS	Call by reference	☐	Type reference (TYPE)	TT_ACTIONS			20060118
2	Importing	IN_CHANGE_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_CHANGE_HANDLER			20060118
3	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20060118
4	Changing	IN_MODIFICATIONS	Call by reference	☐	Type reference (TYPE)	TT_MODIFICATIONS			20060118

Method UPDATE_SUBSTITUTE on class /RPM/CL_SUBSTITUTE_API has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	400