SAP ABAP Class /RPM/CL_COLLECTION_API (xRPM Collection 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	20050609
2	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_DASHBOARD	Dashboard Interface	20070602
3	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_METADATA	Metadata for API objects	20080811
4	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_PROVIDER_ACCESS	ESA: "CRUD"-Interface Pattern	20050609
5	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_PROVIDER_ACTION	ESA: "Action"-Interface Pattern	20050609
6	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_PROVIDER_QUERY	ESA: "Query"-Interface-Pattern	20050609
7	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_PROVIDER_TRANSACTION	ESA: "Transaction"-Interface Pattern	20050609

Properties

Class	/RPM/CL_COLLECTION_API
Short Description	xRPM Collection 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	20050609	SAP
Last change	20141109
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /RPM/CL_COLLECTION_API has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	/RPM/IF_DASHBOARD	☐	☐	Dashboard Interface	20070602
2	/RPM/IF_METADATA	☐	☐	Metadata for API objects	20080811
3	/RPM/IF_PROVIDER_ACCESS	☐	☐	ESA: "CRUD"-Interface Pattern	20050609
4	/RPM/IF_PROVIDER_ACTION	☐	☐	ESA: "Action"-Interface Pattern	20050609
5	/RPM/IF_PROVIDER_QUERY	☐	☐	ESA: "Query"-Interface-Pattern	20050609
6	/RPM/IF_PROVIDER_TRANSACTION	☐	☐	ESA: "Transaction"-Interface Pattern	20050609

Friends

Class /RPM/CL_COLLECTION_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MV_PARENT_TYPE	Instance attribute	Public	☐	Type reference (TYPE)	/RPM/OBJECT_TYPE		Object Type	20090129
2	OR_BUCKET	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/RPM/CL_BUCKET_O		Hierarchy bucket operational object	20050609
3	OR_OBJECT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/RPM/CL_COLLECTION_O		Hierarchy Review operational object	20050609
4	OR_PORTFOLIO	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/RPM/CL_ENTITY_PROJECT		General object definition	20050609
5	OS_MODE	Instance attribute	Public	☐	Type reference (TYPE)	/RPM/TS_CHANGE_MODE		Object Change Mode	20050726
6	OT_GUID	Instance attribute	Public	☐	Type reference (TYPE)	/RPM/TT_GUIDS		Table of RPM guids	20050609
7	OV_ACTION_LOCK	Constant	Public	☐	Type reference (TYPE)	STRING	'LOCK_OBJECT'		20080812
8	OV_ACTION_UNLOCK	Constant	Public	☐	Type reference (TYPE)	STRING	'UNLOCK_OBJECT'		20080812
9	OV_LANGU	Instance attribute	Private	☐	Type reference (TYPE)	LANGU		Language Key	20050609
10	OV_NODE_DETAIL	Constant	Public	☐	Type reference (TYPE)	STRING	'DETAIL'		20050609
11	OV_QUERY_GETLIST	Constant	Public	☐	Type reference (TYPE)	STRING	'GET_LIST'		20050609
12	OV_RC	Instance attribute	Public	☐	Type reference (TYPE)	I			20050726
13	SR_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	/RPM/CL_OBJECT_API		xRPM Object Provider Super Class	20060421

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTION_MANDATORY_FIELD_CHK	Instance method	Private	Method	Mandatory field check	20080820
2	ACTION_SUB_OBJECT_CHANGED	Instance method	Private	Method	Add sub object change information	20100322
3	CHECK_GET_LIST_AUTHORIZATION	Instance method	Public	Method		20050819
4	COLLECTION_UNLOCK	Instance method	Public	Method		20080812
5	CONSIDER_AUTHORIZATIONS	Instance method	Private	Method		20070213
6	CONSTRUCTOR	Instance method	Public	Constructor		20060421
7	CREATE_OBJECT	Instance method	Private	Method	Create collection object	20050609
8	GET_ACL_PERMISSIONS	Instance method	Private	Method	Get the ACL permissions	20050609
9	GET_COLL_ITEMS_COUNT	Instance method	Private	Method		20081104
10	GET_INSTANCE	Static method	Public	Method		20060421
11	GET_OBJECT	Instance method	Private	Method	Get the collection object	20050609
12	GET_OBJECT_ATTRIBUTES	Instance method	Private	Method	Get the object attributes	20050609
13	GET_PARENT_DESCRIPTION	Instance method	Private	Method	Get the description, and id for the parent	20050609
14	GET_PORTFOLIO	Instance method	Private	Method	Get's the core portfolio object	20050609
15	GET_PORTFOLIO_BUCKETS	Instance method	Private	Method	Get all the buckets within a Portfolio	20050609
16	MODIFY_COLLECTIONS	Instance method	Private	Method	Modify Collections -Create, Update, Delete	20050705
17	ON_CHANGES_COMMITED	Instance method	Private	Event handling method	Responder to changes committed of object manager	20060421
18	ON_SAVE_REQUESTED	Instance method	Private	Event handling method	Responder to save requested of object manager	20060421
19	QUERY_GETLIST	Instance method	Private	Method	Get the list of Collections	20050609
20	SET_CHANGE_MODE	Instance method	Private	Method		20050715
21	SET_PARENT_TYPE	Instance method	Public	Method	Set the parent type	20090129

Events

Class /RPM/CL_COLLECTION_API has no event.

Types

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

Method Signatures

Method ACTION_MANDATORY_FIELD_CHK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_ACTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20080820
2	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20080820
3	Importing	IN_CHANGE_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_CHANGE_HANDLER			20080820
4	Importing	IN_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20080820
5	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20080820
6	Importing	IN_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY			20080820
7	Exporting	OUT_REJECTED	Call by reference	☐	Type reference (TYPE)	SCOL_BOOLEAN		Boolean	20080820

Method ACTION_MANDATORY_FIELD_CHK on class /RPM/CL_COLLECTION_API has no exception.

Method ACTION_SUB_OBJECT_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_ACTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100322
2	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100322
3	Importing	IN_CHANGE_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_CHANGE_HANDLER			20100322
4	Importing	IN_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20100322
5	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20100322
6	Importing	IN_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY			20100322
7	Exporting	OUT_REJECTED	Call by reference	☐	Type reference (TYPE)	SCOL_BOOLEAN		Boolean	20100322

Method ACTION_SUB_OBJECT_CHANGED on class /RPM/CL_COLLECTION_API has no exception.

Method CHECK_GET_LIST_AUTHORIZATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_API_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	/RPM/TT_COLLECTION_API		API Sammlung	20050819
2	Importing	IT_API_ATTRIBUTES	Value transfer	☑	Type reference (TYPE)	/RPM/TT_COLLECTION_API		API Sammlung	20050819
3	Importing	IV_MY_OBJECTS	Value transfer	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20060301

Method CHECK_GET_LIST_AUTHORIZATION on class /RPM/CL_COLLECTION_API has no exception.

Method COLLECTION_UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	/RPM/TV_GUID		Guid for application objects	20080812
2	Importing	IV_LANG	Call by reference	☑	Type reference (TYPE)	LAISO		Language according to ISO 639	20080812

Method COLLECTION_UNLOCK on class /RPM/CL_COLLECTION_API has no exception.

Method CONSIDER_AUTHORIZATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_COLLECTIONS	Call by reference	☐	Type reference (TYPE)	/RPM/TT_COLLECTIONS_DB		Collections	20070213
2	Importing	IS_CONTEXT	Call by reference	☐	Type reference (TYPE)	/RPM/TS_OBJECT_HIER		Portfolio Hierarchy	20070213
3	Importing	IT_AUTHORIZED_OBJECTS	Call by reference	☐	Type reference (TYPE)	ACO_TT_USER		List of Object-Related Authorizations for a User	20070213
4	Importing	IT_STRUCTURE	Call by reference	☑	Type reference (TYPE)	/RPM/TT_OBJECT_HIER		Table Type for Object Hierarchy	20070213
5	Importing	IV_BYPASS_AUTHORIZATIONS	Call by reference	☑	Type reference (TYPE)	XFELD		Checkbox	20071212
6	Importing	IV_INHERIT_FROM	Call by reference	☑	Type reference (TYPE)	CGPL_OBJECT_TYPE		Object Type in Project Planning	20070213

Method CONSIDER_AUTHORIZATIONS on class /RPM/CL_COLLECTION_API has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	SYLANGU		Language Key of Current Text Environment	20060421

Method CONSTRUCTOR on class /RPM/CL_COLLECTION_API has no exception.

Method CREATE_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	/RPM/TS_COLLECTION_API		Review-API	20050609
2	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LAISO		Sprache nach ISO 639	20050609

Method CREATE_OBJECT on class /RPM/CL_COLLECTION_API has no exception.

Method GET_ACL_PERMISSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	LAISO		Sprache nach ISO 639	20050609
2	Returning	RT_USER_PERMISSIONS	Value transfer	☐	Type reference (TYPE)	/RPM/TT_ACO_PERMISSIONS		Berechtigungsliste für Benutzer	20050609

Method GET_ACL_PERMISSIONS on class /RPM/CL_COLLECTION_API has no exception.

Method GET_COLL_ITEMS_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_COUNT	Call by reference	☐	Type reference (TYPE)	I			20081104
2	Importing	IS_CONTEXT	Call by reference	☐	Type reference (TYPE)	/RPM/TS_OBJECT_HIER		Portfolio Hierarchy	20081104

Method GET_COLL_ITEMS_COUNT on class /RPM/CL_COLLECTION_API has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	SYLANGU		Language Key of Current Text Environment	20060421
2	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	/RPM/CL_OBJECT_API		xRPM Object Provider Super Class	20060421

Method GET_INSTANCE on class /RPM/CL_COLLECTION_API has no exception.

Method GET_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECTREF	Call by reference	☑	Type reference (TYPE)	/RPM/TS_COLLECTION_KEY		Reviews in Bereichshierarchie	20050609
2	Importing	IV_EXTERNAL_ID	Call by reference	☑	Type reference (TYPE)	RPM_TV_EXTID		Externe ID	20050609
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LAISO		Sprache nach ISO 639	20050609
4	Returning	RR_ITEM	Value transfer	☐	Object reference (TYPE REF TO)	/RPM/CL_ENTITY_PROJECT		Allgemeine Objektdefinition	20050609

#	Exception	Resumable	Description	Created on
1	CX_RPM_OBJECT_NOT_FOUND_ERROR	☐	Application Object Not Found in Database	20090811

Method GET_OBJECT_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	LAISO		Sprache nach ISO 639	20050609
2	Exporting	RS_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	/RPM/TS_COLLECTION_API		Review-API	20050609
3	Exporting	RS_ATTRIBUTES_OLD	Value transfer	☐	Type reference (TYPE)	/RPM/TS_COLLECTION_API		Collection API	20060426

Method GET_OBJECT_ATTRIBUTES on class /RPM/CL_COLLECTION_API has no exception.

Method GET_PARENT_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	/RPM/TV_SHARED_DESCRIPTION		RPM-Datenelement: Bezeichnung Anwendungsobjekt	20050609
2	Exporting	EV_EXTID	Call by reference	☐	Type reference (TYPE)	/RPM/TV_EXTID		Externe ID	20050609

Method GET_PARENT_DESCRIPTION on class /RPM/CL_COLLECTION_API has no exception.

Method GET_PORTFOLIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECTREF	Call by reference	☑	Type reference (TYPE)	/RPM/TS_REVIEW_KEY		Reviews in Bereichshierarchie	20050609
2	Importing	IV_EXTERNAL_ID	Call by reference	☑	Type reference (TYPE)	RPM_TV_EXTID		Externe ID	20050609
3	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	LAISO		Sprache nach ISO 639	20050609
4	Returning	RR_PORTFOLIO	Value transfer	☐	Object reference (TYPE REF TO)	/RPM/CL_ENTITY_PROJECT		Allgemeine Objektdefinition	20050609

Method GET_PORTFOLIO on class /RPM/CL_COLLECTION_API has no exception.

Method GET_PORTFOLIO_BUCKETS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_SELECTION_PARAMETERS	Call by reference	☑	Type reference (TYPE)	TT_SELECTION_PARAMETERS			20050609
2	Importing	IS_OBJECTREF	Call by reference	☑	Type reference (TYPE)	/RPM/TS_REVIEW_KEY		Reviews in Bereichshierarchie	20050609
3	Importing	IV_EXTERNAL_ID	Call by reference	☑	Type reference (TYPE)	RPM_TV_EXTID		Externe ID	20050609
4	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	LAISO		Sprache nach ISO 639	20050609
5	Returning	RT_BUCKETS	Value transfer	☐	Type reference (TYPE)	/RPM/TT_ENTITIES		RPM-Tabellentyp: Entitätsobjekt	20050609

Method GET_PORTFOLIO_BUCKETS on class /RPM/CL_COLLECTION_API has no exception.

Method MODIFY_COLLECTIONS 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			20050705
2	Importing	IN_CHANGE_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_CHANGE_HANDLER			20050705
3	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message-Handler-Schnittstelle	20050705
4	Changing	IN_MODIFICATIONS	Call by reference	☐	Type reference (TYPE)	TT_MODIFICATIONS			20050705

Method MODIFY_COLLECTIONS on class /RPM/CL_COLLECTION_API has no exception.

Method ON_CHANGES_COMMITED Signature

Method ON_CHANGES_COMMITED on class /RPM/CL_COLLECTION_API has no parameter.
Method ON_CHANGES_COMMITED on class /RPM/CL_COLLECTION_API has no exception.

Method ON_SAVE_REQUESTED Signature

Method ON_SAVE_REQUESTED on class /RPM/CL_COLLECTION_API has no parameter.
Method ON_SAVE_REQUESTED on class /RPM/CL_COLLECTION_API has no exception.

Method QUERY_GETLIST 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			20050609
2	Importing	IN_FILL_DATA	Call by reference	☐	Type reference (TYPE)	SCOL_BOOLEAN	SPACE	OUT_DATA muß gefüllt werden	20050609
3	Importing	IN_FILTER_KEYS	Call by reference	☑	Type reference (TYPE)	INDEX TABLE		Filterung auf Keys	20050609
4	Importing	IN_MESSAGE_BUFFER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message-Handler-Schnittstelle	20050609
5	Importing	IN_QUERY_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Query-Name	20050609
6	Importing	IN_QUERY_OPTIONS	Call by reference	☑	Type reference (TYPE)	TY_QUERY_OPTIONS		Optionen einer Query	20050609
7	Importing	IN_SELECTION_PARAMETERS	Call by reference	☑	Type reference (TYPE)	TT_SELECTION_PARAMETERS		Selektionsparameter	20050609
8	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20050609
9	Exporting	OUT_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20050609
10	Exporting	OUT_QUERY_INFO	Call by reference	☐	Type reference (TYPE)	TY_QUERY_INFO			20050609

Method QUERY_GETLIST on class /RPM/CL_COLLECTION_API has no exception.

Method SET_CHANGE_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RC	Call by reference	☐	Type reference (TYPE)	I			20080827
2	Importing	IR_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_ENTITY		Entitätsschnittstelle	20050715
3	Importing	IV_SET_MODE	Call by reference	☐	Type reference (TYPE)	I			20050715
4	Exporting	RS_MODE	Call by reference	☐	Type reference (TYPE)	/RPM/TS_CHANGE_MODE		Objektänderungsmodus	20050715

Method SET_CHANGE_MODE on class /RPM/CL_COLLECTION_API has no exception.

Method SET_PARENT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PARENT_TYPE	Call by reference	☐	Type reference (TYPE)	/RPM/OBJECT_TYPE		Object Type	20090129

Method SET_PARENT_TYPE on class /RPM/CL_COLLECTION_API has no exception.

History

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