SAP ABAP Class /RPM/CL_DOCUMENTS (PPM: Collection for Documents)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PPM-PFM (Application Component) Portfolio Management
     ⤷ /RPM/DOCUMENT (Package) RPM Document Objects

Properties

Class	/RPM/CL_DOCUMENTS
Short Description	PPM: Collection for Documents
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	/RPM/DOCUMENT	RPM Document Objects
Created	20080526	SAP
Last change	20141109
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/RPM/CL_CO	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CL_DPR_CO	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_RPM_CO	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class /RPM/CL_DOCUMENTS has no interface implemented.

Friends

Class /RPM/CL_DOCUMENTS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_OBJ_MANAGER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/RPM/CL_OBJ_MANAGER		RPM Project and Portfolio Controller	20080530
2	MR_OBJ_MAPPER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/RPM/CL_OBJ_MAPPER		Mapper GUIDs -> Application Object	20080530
3	MR_PARENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/RPM/IF_ENTITY		Entity interface	20080530
4	MT_DELETED_ITEMS	Instance attribute	Private	☐	Type reference (TYPE)	/RPM/TT_DOCUMENTS		RPM Table Type: Entity objects	20080530
5	MT_DOC_OBJECTS	Instance attribute	Private	☐	Type reference (TYPE)	/RPM/TT_DOCUMENTS		Table Type for Documents	20090121
6	MT_DOC_T_AREAS	Instance attribute	Private	☐	Type reference (TYPE)	/RPM/TT_DOC_T_AREA		GUIDs for the Document Template Area	20080929
7	MT_EDMS_SUBAPPL	Instance attribute	Private	☐	Type reference (TYPE)	DPR_TT_COLL_EDMS_W_SUBAPPL		EDMS Documents per Subapplication	20080526
8	MV_CLASSNAME_ITEM	Instance attribute	Public	☐	Type reference (TYPE)	SEOCLSNAME		Object Type Name	20080605
9	MV_EDMS_HIERARCHY_READ	Instance attribute	Private	☐	Type reference (TYPE)	BOOLE_D		EDMS documents were read	20080526
10	MV_EDMS_SUBAPPL	Instance attribute	Private	☐	Type reference (TYPE)	EDMS_TV_SUBAPPLICATION		Subapplication for EDMS	20080526
11	MV_IS_FREEING	Instance attribute	Private	☐	Type reference (TYPE)	XFELD		Checkbox	20080530
12	MV_IS_HIER_NODE	Instance attribute	Public	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20080605
13	SV_OBJECT_TYPE	Static Attribute	Private	☐	Type reference (TYPE)	CGPL_OBJECT_TYPE		Object Type in Project Planning	20080630

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD	Instance method	Public	Method	Add Object	20080526
2	ADD_DELETED_ITEM	Instance method	Public	Method	Add deleted object to collection	20080529
3	BUILD_PARENT	Instance method	Private	Method	Build parent of object	20080529
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20080526
5	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20080526
6	COPY	Instance method	Public	Method	Copy Object	20080526
7	CREATE	Static method	Public	Method	Create Collection	20080526
8	CREATE_WITH_TECHNICAL_OBJECT	Instance method	Private	Method	Create new app object with the technical CGPL object	20080529
9	DELETE	Instance method	Public	Method	Delete Object	20080526
10	DELETE_ALL	Instance method	Public	Method	Delete All Objects	20080526
11	FREE	Instance method	Private	Method	Destructor	20080526
12	GET_ALL	Instance method	Public	Method	Access Method to All Objects (Reading)	20080526
13	GET_ALL_BY_SUBAPPLICATION	Instance method	Public	Method	Access Method to Documents of a Subapplication (Reading)	20080526
14	GET_ALL_FOR_ASSIGNMENT	Instance method	Private	Method	Access Method to All/One/the First Object (Reading)	20080609
15	GET_ALL_INTERNAL	Instance method	Private	Method	Access Method to All/One/the First Object (Reading)	20080606
16	GET_BY_EDMS_DOCID	Instance method	Public	Method	Access Method with EDMS GUID (Reading)	20080526
17	GET_BY_GUID	Instance method	Public	Method	Access Method with GUID (Reading)	20080526
18	GET_BY_INDEX	Instance method	Public	Method	Access Method with Index (Reading)	20080526
19	GET_NUMBER	Instance method	Public	Method	Get total number of objects	20080529
20	GET_NUMBER_BY_TYPE	Instance method	Public	Method	Access Method to Number of EDMS Documents/Folders	20080526
21	GET_OBJECT_TYPE	Instance method	Public	Method	Get object type of colllection objects	20080529
22	GET_PARENT	Instance method	Public	Method	Return app object parent	20080529
23	GET_TEMPL_AREAS	Instance method	Public	Method	Gets the Template Areas	20080929
24	HAS_ENTRIES	Instance method	Public	Method	Do any objects exist in the collection?	20080529
25	ON_COLL_MODEL_CREATED	Static method	Private	Event handling method	Event Handler CREATED:/RPM/IF_DOC_COLL_MODEL	20080526
26	ON_PARENT_CREATED	Instance method	Private	Event handling method	Handling Method CREATED: /RPM/IF_COMMON	20080929
27	ON_PARENT_FREED	Instance method	Private	Event handling method	Handling Method FREED: /RPM/IF_COMMON	20080526
28	ON_PARENT_LOADED	Instance method	Private	Event handling method	Handling Method LOADED: /RPM/IF_COMMON	20080929
29	ON_PROXY_CREATED	Static method	Private	Event handling method	Event Handler for CREATED:/RPM/IF_DOC_COLL_PROXY	20080526
30	ON_PROXY_DELETED	Static method	Private	Event handling method	Event Handler for DELETED:/RPM/IF_DOC_COLL_PROXY	20080526
31	READ_EDMS_HIERARCHY	Instance method	Public	Method	Read All Documents in EDMS Hierarchy	20080526
32	REMOVE_DELETED_ITEM	Instance method	Public	Method	Remove the deleted object from the collection	20080529

Events

Class /RPM/CL_DOCUMENTS has no event.

Types

Class /RPM/CL_DOCUMENTS has no local type.

Method Signatures

Method ADD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	/RPM/CL_DOCUMENT		PPM: Document	20080526

#	Exception	Resumable	Description	Created on
1	CX_RPM_OBJECT_CREATION_ERROR	☐	Development Projects: Error When Creating Application Object	20080606

Method ADD_DELETED_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DELETED_ITEM	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/CL_DOCUMENT		PPM: Document	20080529

Method ADD_DELETED_ITEM on class /RPM/CL_DOCUMENTS has no exception.

Method BUILD_PARENT Signature

Method BUILD_PARENT on class /RPM/CL_DOCUMENTS has no parameter.
Method BUILD_PARENT on class /RPM/CL_DOCUMENTS has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /RPM/CL_DOCUMENTS has no parameter.
Method CLASS_CONSTRUCTOR on class /RPM/CL_DOCUMENTS has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_ENTITY		Superior Application Object	20080526
2	Importing	IV_EDMS_SUBAPPL	Call by reference	☐	Type reference (TYPE)	EDMS_TV_SUBAPPLICATION	/RPM/CL_CO=>SC_EDMS_SUBAPPL_RPM	Subapplication for EDMS	20080526
3	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	CGPL_OBJECT_TYPE		Object Category	20080526

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

Method COPY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_SOURCE	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/CL_DOCUMENT		Source Document	20080526
2	Returning	RR_TARGET	Value transfer	☐	Object reference (TYPE REF TO)	/RPM/CL_DOCUMENT		Target Document	20080526

#	Exception	Resumable	Description	Created on
1	CX_DPR_OBJECT_CREATION_ERROR	☐	Development Projects: Error When Creating Application Object	20080526

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_ENTITY		Superior Application Object	20080526
2	Importing	IV_EDMS_SUBAPPL	Call by reference	☐	Type reference (TYPE)	EDMS_TV_SUBAPPLICATION	/RPM/CL_CO=>SC_EDMS_SUBAPPL_RPM	Subapplication for EDMS	20080526
3	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	/RPM/CL_DOCUMENTS		New Collection Instance	20080526

Method CREATE on class /RPM/CL_DOCUMENTS has no exception.

Method CREATE_WITH_TECHNICAL_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_TECHNICAL_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_ASSIGNMENT		PPM: Interface for all assignments	20080529
2	Returning	RR_COMMON	Value transfer	☐	Object reference (TYPE REF TO)	/RPM/IF_COMMON		Interface for all application objects	20080611

Method CREATE_WITH_TECHNICAL_OBJECT on class /RPM/CL_DOCUMENTS has no exception.

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/CL_DOCUMENT		PPM: Document	20080526
2	Importing	IV_CHECK_ONLY	Call by reference	☑	Type reference (TYPE)	BOOLE_D	/RPM/CL_CO=>SC_FALSE	Boolean Value: Only Check if Object Can Be Deleted	20080526
3	Returning	RV_RC	Value transfer	☐	Type reference (TYPE)	I		Return Value (0 = Call OK)	20080526

#	Exception	Resumable	Description	Created on
1	CX_RPM_OBJECT_DELETION_ERROR	☐	Development Projects: Error When Deleting Application Object	20080606

Method DELETE_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHECK_ONLY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	/RPM/CL_CO=>SC_FALSE	Boolean Value: Only Check if Object Can Be Deleted	20080526
2	Returning	RV_RC	Value transfer	☐	Type reference (TYPE)	I		Return Value (0 = Call OK)	20080526

#	Exception	Resumable	Description	Created on
1	CX_RPM_OBJECT_DELETION_ERROR	☐	Development Projects: Error When Deleting Application Object	20080703

Method FREE Signature

Method FREE on class /RPM/CL_DOCUMENTS has no parameter.
Method FREE on class /RPM/CL_DOCUMENTS has no exception.

Method GET_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_DOCUMENTS	Value transfer	☐	Type reference (TYPE)	/RPM/TT_DOCUMENTS		Table Type for Documents	20080526

Method GET_ALL on class /RPM/CL_DOCUMENTS has no exception.

Method GET_ALL_BY_SUBAPPLICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SUBAPPLICATION	Call by reference	☑	Type reference (TYPE)	EDMS_TV_SUBAPPLICATION		Subapplication for EDMS	20080526
2	Returning	RT_DOCUMENTS	Value transfer	☐	Type reference (TYPE)	/RPM/TT_DOCUMENTS		Table Type for Documents	20080526

Method GET_ALL_BY_SUBAPPLICATION on class /RPM/CL_DOCUMENTS has no exception.

Method GET_ALL_FOR_ASSIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOCUMENTS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Table Type for Application Objects	20080611
2	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	/RPM/TV_GUID		Application Object GUID	20080609
3	Importing	IV_STOP_AFTER_FIRST_ITEM	Call by reference	☐	Type reference (TYPE)	BOOLE_D	/RPM/CL_CO=>SC_FALSE	Stop if First Entry Was Found in Collection	20080609

Method GET_ALL_FOR_ASSIGNMENT on class /RPM/CL_DOCUMENTS has no exception.

Method GET_ALL_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOCUMENTS	Call by reference	☐	Type reference (TYPE)	/RPM/TT_DOCUMENTS		Table Type for Documents	20080606
2	Importing	IV_GUID	Call by reference	☑	Type reference (TYPE)	/RPM/TV_GUID		Application Object GUID	20080606
3	Importing	IV_STOP_AFTER_FIRST_ITEM	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20080606

Method GET_ALL_INTERNAL on class /RPM/CL_DOCUMENTS has no exception.

Method GET_BY_EDMS_DOCID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOCID	Call by reference	☐	Type reference (TYPE)	EDMS_DOCID		EDMS: Document ID	20080526
2	Importing	IV_DOCID_ALTERNATE	Call by reference	☑	Type reference (TYPE)	EDMS_DOCID		EDMS: Document ID	20080526
3	Returning	RR_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	/RPM/CL_DOCUMENT		PPM: Document	20080526

Method GET_BY_EDMS_DOCID on class /RPM/CL_DOCUMENTS has no exception.

Method GET_BY_GUID 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		Application Object GUID	20080526
2	Returning	RR_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	/RPM/CL_DOCUMENT		PPM: Document	20080526

Method GET_BY_GUID on class /RPM/CL_DOCUMENTS has no exception.

Method GET_BY_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/CL_DOCUMENT		PPM: Document	20080526
2	Exporting	EV_RC	Call by reference	☐	Type reference (TYPE)	I		Return Value (0 = Call OK)	20080526
3	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	I		Index	20080526

Method GET_BY_INDEX on class /RPM/CL_DOCUMENTS has no exception.

Method GET_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NUMBER	Value transfer	☐	Type reference (TYPE)	I			20080529

Method GET_NUMBER on class /RPM/CL_DOCUMENTS has no exception.

Method GET_NUMBER_BY_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NUMBER_EDMS_DOCUMENTS	Call by reference	☐	Type reference (TYPE)	I		Number of EDMS Documents	20080526
2	Exporting	EV_NUMBER_EDMS_FOLDERS	Call by reference	☐	Type reference (TYPE)	I		Number of EDMS Folders	20080526

Method GET_NUMBER_BY_TYPE on class /RPM/CL_DOCUMENTS has no exception.

Method GET_OBJECT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_OBJECT_TYPE	Value transfer	☐	Type reference (TYPE)	CGPL_OBJECT_TYPE		Object Type in Project Planning	20080529

Method GET_OBJECT_TYPE on class /RPM/CL_DOCUMENTS has no exception.

Method GET_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_PARENT	Value transfer	☐	Object reference (TYPE REF TO)	/RPM/IF_ENTITY		Entity interface	20080529

Method GET_PARENT on class /RPM/CL_DOCUMENTS has no exception.

Method GET_TEMPL_AREAS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	CGPL_OBJECT_TYPE		Object Type in Project Planning	20080929
2	Returning	RT_DOC_T_AREAS	Value transfer	☐	Type reference (TYPE)	/RPM/TT_DOC_T_AREA		GUIDs for the Document Template Area	20080929

Method GET_TEMPL_AREAS on class /RPM/CL_DOCUMENTS has no exception.

Method HAS_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_HAS_ENTRIES	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20080529

Method HAS_ENTRIES on class /RPM/CL_DOCUMENTS has no exception.

Method ON_COLL_MODEL_CREATED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ER_COLL_MODEL	Call by reference	☐	Attribute reference (LIKE)				20080526

Method ON_COLL_MODEL_CREATED on class /RPM/CL_DOCUMENTS has no exception.

Method ON_PARENT_CREATED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SENDER	Call by reference	☐	Attribute reference (LIKE)				20080929

Method ON_PARENT_CREATED on class /RPM/CL_DOCUMENTS has no exception.

Method ON_PARENT_FREED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SENDER	Call by reference	☐	Attribute reference (LIKE)				20080526

Method ON_PARENT_FREED on class /RPM/CL_DOCUMENTS has no exception.

Method ON_PARENT_LOADED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SENDER	Call by reference	☐	Attribute reference (LIKE)				20080929

Method ON_PARENT_LOADED on class /RPM/CL_DOCUMENTS has no exception.

Method ON_PROXY_CREATED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ER_PARENT	Call by reference	☐	Attribute reference (LIKE)				20080526
2	Importing	ER_PROXY	Call by reference	☐	Attribute reference (LIKE)				20080526

Method ON_PROXY_CREATED on class /RPM/CL_DOCUMENTS has no exception.

Method ON_PROXY_DELETED Signature

Method ON_PROXY_DELETED on class /RPM/CL_DOCUMENTS has no parameter.
Method ON_PROXY_DELETED on class /RPM/CL_DOCUMENTS has no exception.

Method READ_EDMS_HIERARCHY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EDMS_SUBAPPL	Call by reference	☐	Type reference (TYPE)	EDMS_TV_SUBAPPLICATION	/RPM/CL_CO=>SC_EDMS_SUBAPPL_RPM	Subapplication for EDMS	20080526
2	Returning	RV_ALREADY_READ	Value transfer	☐	Type reference (TYPE)	BOOLE_D		'X' If Hierarchy Was Already Read	20080526

Method READ_EDMS_HIERARCHY on class /RPM/CL_DOCUMENTS has no exception.

Method REMOVE_DELETED_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DELETED_ITEM	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/CL_DOCUMENT		PPM: Document	20080529

Method REMOVE_DELETED_ITEM on class /RPM/CL_DOCUMENTS has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	500_701