SAP ABAP Class CL_DPR_API_DOCUMENT (Proj. Mgmt API: Abstract Application Object for Documents)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PPM-PRO-EXT-API (Application Component) BAPI Interface for cProjects
     ⤷ DEVELOPMENT_PROJECTS_API (Package) API for Project Management

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_DPR_API_APPLICATION_OBJECT	Abstract Application Object	20041227

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_DPR_API_DOCUMENT_O	Proj. Mgmt API: Documents	20041206
2	Inheritance (c INHERITING FROM c_ref)	CL_DPR_API_DOCUMENT_T	Proj. Mgmt API: Documents in Template	20050302

Properties

Class	CL_DPR_API_DOCUMENT
Short Description	Proj. Mgmt API: Abstract Application Object for Documents
Super Class	CL_DPR_API_APPLICATION_OBJECT	Abstract Application Object
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	DEVELOPMENT_PROJECTS_API	API for Project Management
Created	20041202	SAP
Last change	20141109
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	CL_DPR_CO	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_DPR_API_DOCUMENT has no interface implemented.

Friends

Class CL_DPR_API_DOCUMENT has no friend class.

Attributes

Class CL_DPR_API_DOCUMENT has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	DO_ACTION_DOC_COPY_AND_PASTE	Instance method	Private	Method	Copy Document	20050304
2	DO_ACTION_DOC_CREATE_LINK	Instance method	Private	Method	Create Link to Template Document	20050413
3	DO_ACTION_DOC_CUT_AND_PASTE	Instance method	Private	Method	Move Document	20050304
4	DO_ACTION_DOC_SET_STATUS	Instance method	Private	Method	Change Document Status	20050304
5	DO_ACTION_MARK_CONTENT_PRELIM	Instance method	Private	Method		20100408
6	EDMS_GET_DATA_EXT	Instance method	Private	Method	Read Document Data in External Display	20060728
7	GET_ALL_AUTHORIZATIONS	Instance method	Private	Method	Import all Authorizations	20050321
8	GET_ALL_DOC_VERSIONS	Instance method	Private	Method	Import All Document Versions	20041227
9	GET_EDMS_SUBAPPLICATION	Instance method	Private	Method	Target Folder Is Permitted for Inserted Document/Folder	20070212
10	GET_HTTP_URL	Instance method	Private	Method	Determine the HTTP URL for checkin the Content	20100412
11	TARGET_IS_VALID_4_INSERT	Instance method	Private	Method	Target Folder Is Permitted for Inserted Document/Folder	20061106

Events

#	Event	Type	Visibility	Description	Created on
1	DOCUMENT_COPIED	Instance Event (0)	Public (2)	Document Has Been Copied/Moved	20050422

Types

Class CL_DPR_API_DOCUMENT has no local type.

Method Signatures

Method DO_ACTION_DOC_COPY_AND_PASTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_REJECTED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20050304
2	Importing	IR_CHANGE_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_CHANGE_HANDLER			20050304
3	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_COMMON		Development Projects: Schnittstelle aller Anwendungsobjekte	20050304
4	Importing	IR_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_MESSAGE_BUFFER		Message Handler Interface	20050304
5	Importing	IS_KEY	Call by reference	☐	Type reference (TYPE)	ANY			20050304
6	Importing	IS_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY		Aktions-Key	20050304
7	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20050304

Method DO_ACTION_DOC_COPY_AND_PASTE on class CL_DPR_API_DOCUMENT has no exception.

Method DO_ACTION_DOC_CREATE_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_REJECTED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20050413
2	Importing	IR_CHANGE_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_CHANGE_HANDLER			20050413
3	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_COMMON		Development Projects: Schnittstelle aller Anwendungsobjekte	20050413
4	Importing	IR_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_MESSAGE_BUFFER		Message Handler Interface	20050413
5	Importing	IS_KEY	Call by reference	☐	Type reference (TYPE)	ANY			20050413
6	Importing	IS_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY		Aktions-Key	20050413
7	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20050413

Method DO_ACTION_DOC_CREATE_LINK on class CL_DPR_API_DOCUMENT has no exception.

Method DO_ACTION_DOC_CUT_AND_PASTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_REJECTED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20050304
2	Importing	IR_CHANGE_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_CHANGE_HANDLER			20050304
3	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_COMMON		Development Projects: Schnittstelle aller Anwendungsobjekte	20050304
4	Importing	IR_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_MESSAGE_BUFFER		Message Handler Interface	20050304
5	Importing	IS_KEY	Call by reference	☐	Type reference (TYPE)	ANY			20050304
6	Importing	IS_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY		Aktions-Key	20050304
7	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20050304

Method DO_ACTION_DOC_CUT_AND_PASTE on class CL_DPR_API_DOCUMENT has no exception.

Method DO_ACTION_DOC_SET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_REJECTED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20050304
2	Importing	IR_CHANGE_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_CHANGE_HANDLER			20050304
3	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_COMMON		Development Projects: Schnittstelle aller Anwendungsobjekte	20050304
4	Importing	IR_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_MESSAGE_BUFFER		Message Handler Interface	20050304
5	Importing	IS_KEY	Call by reference	☐	Type reference (TYPE)	ANY			20050304
6	Importing	IS_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY		Aktions-Key	20050304
7	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20050304

Method DO_ACTION_DOC_SET_STATUS on class CL_DPR_API_DOCUMENT has no exception.

Method DO_ACTION_MARK_CONTENT_PRELIM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_REJECTED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20100408
2	Importing	IR_CHANGE_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_CHANGE_HANDLER		Change Handler	20100408
3	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_COMMON		Development Projects: Interface for All Application Objects	20100408
4	Importing	IR_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_MESSAGE_BUFFER		Message Handler Interface	20100408
5	Importing	IS_KEY	Call by reference	☐	Type reference (TYPE)	ANY			20100408
6	Importing	IS_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY			20100408
7	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100408

Method DO_ACTION_MARK_CONTENT_PRELIM on class CL_DPR_API_DOCUMENT has no exception.

Method EDMS_GET_DATA_EXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_DOCUMENT_EXT	Call by reference	☐	Type reference (TYPE)	DPR_TS_DOCUMENT_EXT		Attribute Dokument (extern)	20060728
2	Importing	IV_DOCID	Call by reference	☐	Type reference (TYPE)	EDMS_DOCID		EDMS: Dokument-ID	20060728
3	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	LANGU		Sprachenschlüssel	20060728

Method EDMS_GET_DATA_EXT on class CL_DPR_API_DOCUMENT has no exception.

Method GET_ALL_AUTHORIZATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20050321
2	Exporting	ET_LINK_SOURCE_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20050321
3	Exporting	ET_LINK_TARGET_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20050321
4	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_COMMON		Development Projects: Schnittstelle aller Anwendungsobjekte	20050321
5	Importing	IR_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_MESSAGE_BUFFER		Message Handler Interface	20050321
6	Importing	IR_PROPERTY_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_PROPERTY_HANDLER		Attribute Handler Interface	20050321
7	Importing	IT_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Attribute Handler Interface	20050321
8	Importing	IV_ASSOCIATION_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Message Handler Interface	20050321
9	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20050321
10	Importing	IV_EDIT_MODE	Call by reference	☐	Type reference (TYPE)	I		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20050321
11	Importing	IV_FILL_DATA	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20050321
12	Importing	IV_FILL_PROPERTIES	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20050321
13	Importing	IV_RETRIEVE_BEFORE_IMAGE	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20050321

Method GET_ALL_AUTHORIZATIONS on class CL_DPR_API_DOCUMENT has no exception.

Method GET_ALL_DOC_VERSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20041227
2	Exporting	ET_LINK_SOURCE_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20041227
3	Exporting	ET_LINK_TARGET_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20041227
4	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_COMMON		Development Projects: Schnittstelle aller Anwendungsobjekte	20041227
5	Importing	IR_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_MESSAGE_BUFFER		Message Handler Interface	20041227
6	Importing	IR_PROPERTY_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DPR_PROPERTY_HANDLER		Attribute Handler Interface	20041227
7	Importing	IV_ASSOCIATION_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Message Handler Interface	20041227
8	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20041227
9	Importing	IV_EDIT_MODE	Call by reference	☐	Type reference (TYPE)	I			20041227
10	Importing	IV_FILL_DATA	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20041227
11	Importing	IV_FILL_PROPERTIES	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20041227
12	Importing	IV_RETRIEVE_BEFORE_IMAGE	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20041227

Method GET_ALL_DOC_VERSIONS on class CL_DPR_API_DOCUMENT has no exception.

Method GET_EDMS_SUBAPPLICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20070212
2	Exporting	ET_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20070212
3	Importing	IT_SELECTION_PARAMETERS	Call by reference	☐	Type reference (TYPE)	TT_SELECTION_PARAMETERS			20070212

Method GET_EDMS_SUBAPPLICATION on class CL_DPR_API_DOCUMENT has no exception.

Method GET_HTTP_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20100412
2	Importing	IT_SELECTION_PARAMETERS	Call by reference	☐	Type reference (TYPE)	TT_SELECTION_PARAMETERS			20100412
3	Importing	IV_QUERY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100412

Method GET_HTTP_URL on class CL_DPR_API_DOCUMENT has no exception.

Method TARGET_IS_VALID_4_INSERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20061106
2	Exporting	ET_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20061106
3	Importing	IT_SELECTION_PARAMETERS	Call by reference	☐	Type reference (TYPE)	TT_SELECTION_PARAMETERS			20061106

Method TARGET_IS_VALID_4_INSERT on class CL_DPR_API_DOCUMENT has no exception.

Event Signatures

Event DOCUMENT_COPIED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	IT_DOCUMENTS	Exporting	Value transfer	☐	Type reference (TYPE)	EDMS_TT_DOCID		EDMS: Liste von Docid's	20050422
2	I_COPIED	Exporting	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Kopiert	20050422
3	I_SOURCE_FOLDER	Exporting	Value transfer	☐	Type reference (TYPE)	EDMS_DOCID		EDMS: Dokument-ID	20050422
4	I_TARGET_FOLDER	Exporting	Value transfer	☐	Type reference (TYPE)	EDMS_DOCID		EDMS: Dokument-ID	20050422

History

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